home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / dwnsrt57.zip / DOWNSORT.DOC < prev    next >
Text File  |  1993-06-27  |  138KB  |  3,567 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                                                                      DOWNSORT
  19.  
  20.                              Maximus CBCS DOWNload file SORT and List Utility
  21.  
  22.                                                    Version 5.7 (OS/2 and DOS)
  23.  
  24.  
  25.  
  26.  
  27.                                                                 June 27, 1993
  28.  
  29.  
  30.                                                                 Rob Hamerling
  31.  
  32.                                                       Vianen, The Netherlands
  33.                                                Phone: ++31-3473-72136 (voice)
  34.                                                        FIDO-net: 2:512/4.1098
  35.  
  36.                    Maximus Download File Sort and List Utility (OS/2 and DOS)
  37.  
  38.  
  39.  
  40.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  41.  
  42.  
  43.  
  44.   CONTENTS
  45.  
  46.  
  47.     1.0 About Downsort  . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  48.     1.1 Registration and Shareware Fee  . . . . . . . . . . . . . . . . . . 1
  49.     1.2 Warranty  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  50.     1.3 Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . . . 2
  51.  
  52.     2.0 Overview  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  53.     2.1 Purpose and Objectives  . . . . . . . . . . . . . . . . . . . . . . 3
  54.  
  55.     3.0 User's Guide  . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  56.     3.1 Initial setup   . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  57.     3.2 Data Collection   . . . . . . . . . . . . . . . . . . . . . . . . . 6
  58.     3.3 List Type Selection   . . . . . . . . . . . . . . . . . . . . . . . 7
  59.     3.4 Data Selection   . . . . . . . . . . . . . . . . . . . . . . . . . 12
  60.     3.5 List Customisation   . . . . . . . . . . . . . . . . . . . . . . . 12
  61.     3.6 Miscellaneous report information   . . . . . . . . . . . . . . . . 16
  62.  
  63.     4.0 Parameter Specifications   . . . . . . . . . . . . . . . . . . . . 18
  64.     4.1 Commandline parameters   . . . . . . . . . . . . . . . . . . . . . 18
  65.     4.2 Hints for specifications   . . . . . . . . . . . . . . . . . . . . 24
  66.     4.3 Configuration file Parameters  . . . . . . . . . . . . . . . . . . 25
  67.  
  68.     5.0 Sample of Getting organised  . . . . . . . . . . . . . . . . . . . 27
  69.     5.1 Downsort   . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
  70.     5.2 BinkleyTerm  . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
  71.  
  72.     6.0 Packaging  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
  73.     6.1 Availability   . . . . . . . . . . . . . . . . . . . . . . . . . . 29
  74.     6.2 RUN-time material  . . . . . . . . . . . . . . . . . . . . . . . . 29
  75.     6.3 Source material  . . . . . . . . . . . . . . . . . . . . . . . . . 30
  76.     6.4 Installation   . . . . . . . . . . . . . . . . . . . . . . . . . . 30
  77.     6.5 Dependencies and restrictions  . . . . . . . . . . . . . . . . . . 31
  78.     6.6 Storage and Performance  . . . . . . . . . . . . . . . . . . . . . 32
  79.     6.7 Problems   . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
  80.     6.8 Wishlist   . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
  81.  
  82.     7.0 Internals  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
  83.     7.1 Development Environment  . . . . . . . . . . . . . . . . . . . . . 34
  84.     7.2 Program Organisation   . . . . . . . . . . . . . . . . . . . . . . 34
  85.     7.3 Main Data Organisation   . . . . . . . . . . . . . . . . . . . . . 36
  86.  
  87.     Appendix A.  History of changes  . . . . . . . . . . . . . . . . . . . 39
  88.     8.1 Version 5.7  . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
  89.     8.2 Version 5.6  . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
  90.     8.3 Version 5.5  . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
  91.     8.4 Version 5.4  . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
  92.     8.5 Version 5.3  . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
  93.     8.6 Version 5.2  . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
  94.     8.7 Version 5.1  . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
  95.     8.8 Version 5.0  . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
  96.  
  97.     Appendix B.  World-wide use of Downsort  . . . . . . . . . . . . . . . 44
  98.  
  99.  
  100.  
  101.                                                                  Contents  ii
  102.  
  103.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  104.  
  105.  
  106.  
  107.     Appendix C.  Sample Lists  . . . . . . . . . . . . . . . . . . . . . . 45
  108.     10.1 ALL-list  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
  109.     10.2 GBL-list  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
  110.     10.3 NEW-list  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
  111.     10.4 EMI-list  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
  112.     10.5 FILES.BBS   . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
  113.     10.6 OKfile  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
  114.     10.7 ORPhan list   . . . . . . . . . . . . . . . . . . . . . . . . . . 47
  115.  
  116.     Appendix D.  Sample Configuration File   . . . . . . . . . . . . . . . 48
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.                                                                 Contents  iii
  165.  
  166.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  167.  
  168.  
  169.  
  170.   1.0 ABOUT DOWNSORT
  171.  
  172.   Downsort was originated in 1987 as a program for my own use when I was
  173.   SYSOP of the Bulletin Board PC-Square (2:512/4), to automatically generate
  174.   daily overviews of my download material for the users.  The program name is
  175.   related to the SORTing of the collection of DOWNloadable files, in DOWNward
  176.   time-stamp sequence and an online Bulletin was the only list that was
  177.   produced at that time.  PC-Square was running BinkleyTerm and OPUS under
  178.   DOS, and file-requesting was not so popular then.
  179.  
  180.   Now PC-Square runs with OS/2, BinkleyTerm and MAXIMUS CBCS.  I'm not SYSOP
  181.   anymore but still strongly involved.  As a contribution to PC-Square and
  182.   the large international Bulletin Board community of MAXIMUS CBCS boards,
  183.   and in the highly appreciated spirit of BinkleyTerm, I decided to upgrade
  184.   my Downsort program to the current software.  During the past years a lot
  185.   of improvements and extensions have been made: many user-configurable
  186.   options for many more output formats then the original Downsort.
  187.  
  188.   The only dependency of Downsort on MAXIMUS CBCS is a parameter-file
  189.   AREA.DAT, which is usually created with a MAXIMUS utility (SILT(P)), which
  190.   itself can be used without actually running MAXIMUS!  This is the way I
  191.   work for testing of Downsort.
  192.  
  193.   "Appendix A.  History of changes" on page 39 gives an impression of recent
  194.   history.
  195.  
  196.   Downsort is now developed in an OS/2 environment, but it is distributed as
  197. | 'family'-application: it runs under OS/2 and DOS.
  198.  
  199. | Downsort is in its 6-th year of development and has entered a period where
  200. | life becomes more and more complicated.  While adding new features, I have
  201. | tried to maintain compatibility.  This is the main cause of complications.
  202. | Maybe in one of the newer versions I have to leave this compatibility in
  203. | favour of maintainability and user-friendliness.  In anticipation of this,
  204. | please do not use undocumented features, or styles of usage that are not
  205. | described in this document.
  206.  
  207.  
  208.   1.1 REGISTRATION AND SHAREWARE FEE
  209.  
  210.   Downsort is a $ 0.00 Shareware Program.  This means (to me) that you
  211.   respect the commonly known rules for shareware, but you don't have to pay
  212.   me anything.
  213.  
  214.   Registration is voluntary: please send me a netmail message with your name
  215.   and (net-)address if you are a regular user of Downsort as SYSOP.  That
  216.   gives me an impression of the usage and the impact of changes to Downsort.
  217.  
  218.   If you tell me that you are running Downsort on your Bulletin Board as
  219.   service to your users, and you appreciate to be mentioned, I'll add your
  220.   name to the reference list in "Appendix B.  World-wide use of Downsort" on
  221.   page 44.
  222.  
  223.  
  224.  
  225.  
  226.  
  227.                                                             About Downsort  1
  228.  
  229.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  230.  
  231.  
  232.  
  233.   1.2 WARRANTY
  234.  
  235.   For this price?  You must be kidding!  But I'll listen to your complaints
  236.   and suggestions, and if time permits, I'll work on the improvements you
  237.   suggested.
  238.  
  239.  
  240.   1.3 ACKNOWLEDGEMENTS
  241.  
  242.   I would like to thank all users that contributed with constructive remarks
  243.   and encouraging appraisals.  Without doubt Emmanuel Sandorfi of 2:320/5
  244.   holds the record in number of suggestions and amount of additionally
  245.   required programming effort.  He also provided some additional title-fonts
  246.   (2 and 3).
  247.  
  248.   I also would like to thank the regular users (SYSOP's of Bulletin Boards)
  249.   who made Downsort much more popular than I ever dreamed of!  A collection
  250.   of geographically dispersed Boards can be found in "Appendix B.  World-wide
  251.   use of Downsort" on page 44.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.                                                             About Downsort  2
  291.  
  292.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  293.  
  294.  
  295.  
  296.   2.0 OVERVIEW
  297.  
  298.   Downsort is a program to make lists of available download files for
  299.   Bulletin Board Systems, especially MAXIMUS CBCS.  The different types of
  300.   lists are each for a specific audience (online bulletin board user,
  301.   file-requestor, SYSOP) and purpose (all files, recent acquisitions).
  302.   Within each type there are many ways to customise the contents (selection
  303.   on user-privilege or user-interest), and format (sort-sequence of files,
  304.   titles, logo, etc).
  305.  
  306.   Downsort can produce the following report-types (1)for you:
  307.   (all these can be produced in one run).
  308.  
  309.   ■  user-lists
  310.      ∙  BBS-list, a colorful overview for online users of MAXIMUS CBCS
  311.      ∙  NEW-list of the most recent files (as a response to a file-request of
  312.         'NEWFILES')
  313.      ∙  ALL-list for a complete overview in a file-group per area (as a
  314.         response to a filerequest of 'FILES' of 'ALLFILES')
  315.      ∙  IPF-list similar contents as ALL-list, but in a different
  316.         presentation format (VIEW-able under OS/2)
  317.      ∙  GBL-list for a complete overview over the area-boundaries, as an
  318.         alternative for ALL-list if you don't want to bother file-requestors
  319.         with your area-structure
  320.  
  321.   ■  SYSOP lists:
  322.      ∙  ORPHAN-report as a help with management of the contents of your
  323.         area's and directories, and to correct possible upload problems or
  324.         inconsistencies
  325.      ∙  DUP-list for a list of duplicate filenames as a help to control your
  326.         disk-space and with version management.
  327.      ∙  OKFile for (Binkley) File Requests.
  328.      ∙  EMI-list for a list of new file arrivals to be included in an
  329.         announcement message.
  330.      ∙  Updated FILES.BBS files
  331.  
  332.   The lists can be generated for different privilege levels, and be
  333.   customised to a very high extend to present your system as you like it to
  334.   be seen by your users (headers, log, etc).  At the same time Maximus (and
  335.   OPUS) conventions are reflected in the way the file information is
  336.   presented.
  337.  
  338.   A sample of most of these lists can be found in "Appendix C.  Sample Lists"
  339.   on page 45.
  340.  
  341.   In short: Downsort is a very versatile tool to manage your database of
  342.   files, both in an OS/2 and DOS environment.
  343.  
  344.  
  345.   2.1 PURPOSE AND OBJECTIVES
  346.  
  347.  
  348.   ────────────────────
  349.   (1)     For the target audience the distiction between 'user' and 'sysop'
  350.           is strictly the author's view!
  351.  
  352.  
  353.                                                                   Overview  3
  354.  
  355.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  356.  
  357.  
  358.  
  359.   Downsort is designed for the following purposes:
  360.  
  361.   1. Produce different overviews of files which are available for download by
  362.      online users of the Bulletin Board and by File Requestors.  QUICK and
  363.      EASY file retrieval is the main goal for the lists.  Therefore many
  364.      lists-types and within a type several variations should be available for
  365.      SYSOP and users.
  366.  
  367.   2. Should not disclose files to users (file-requesters) without positive
  368.      agreement by SYSOP.
  369.  
  370.   3. Detect discrepancies between the contents of FILES.BBS and the
  371.      corresponding download directory, such as:
  372.      ■  The directory contains so called orphan-files, which have no
  373.         descriptive entry in FILES.BBS.
  374.      ■  FILES.BBS contains entries of which the file in not in the directory
  375.         (is 'offline').  This may be on purpose!
  376.  
  377.   4. Must be able to be run unattended (typically overnight).  The
  378.      file-access privilege system of a Bulletin Board System like Maximus
  379.      CBCS should be respected by the reports.
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.                                                                   Overview  4
  417.  
  418.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  419.  
  420.  
  421.  
  422.   3.0 USER'S GUIDE
  423.  
  424.   This chapter explains the possibilities of Downsort.  Parameter
  425.   specifications will be covered in "4.0 Parameter Specifications" on page
  426.   18.
  427.  
  428.  
  429.   3.1 INITIAL SETUP
  430.  
  431.   When you are going to use Downsort for the first time, you have to make a
  432.   number of decisions.  Below you'll find a kind of check-list, which is
  433.   setup to help you with a logical sequence of tasks to make the use of
  434.   Downsort succesful.  It does NOT give detailed specifications, these can be
  435.   found in "4.0 Parameter Specifications" on page 18.
  436.  
  437.   The specifications will be put into a configuration file Downsort.CFG,
  438.   which may contain information about:
  439.  
  440.   1. Data Collection
  441.  
  442.      File information will be collected from:
  443.      ■  Privilege and download path-information from AREA.DAT
  444.      ■  Actual file-information from download directories
  445.      ■  FILES.BBS files for file descriptions
  446.  
  447.   2. List Type Selection
  448.  
  449.      Downsort can produce the following report types for you (all in one
  450.      run).
  451.      ■  ORPHAN-report for SYSOP use only
  452.      ■  BBS-list for online users of MAXIMUS CBCS
  453.      ■  NEW-list(s) for a list of the most recent files
  454.      ■  ALL-list(s) for a complete overview in a file-group per area
  455.      ■  IPF-list(s) same as ALL-list, but in a different presentation format
  456.         (VIEW-able under OS/2, there is a special IP2-list for OS/2 2.0).
  457.      ■  GBL-list(s) for a complete overview over area-boundaries
  458.      ■  DUP-list(s) for a list of possibly duplicate filenames
  459.      ■  OKFile(s) for (Binkley) File Requests
  460.      ■  EMIFile(s) to for a list of file arrivals over the last period
  461.      ■  Updated FILES.BBS files
  462.  
  463.   3. File selection
  464.  
  465.      Reporting of file-information can be limited by:
  466.      ■  Reporting privilege: only those files up to a certain privilege level
  467.         will be listed
  468.      ■  Area INclude or EXclude: for sub-selection for special interest
  469.         groups
  470.      ■  Number of files or period (days, weeks or months) to be reported
  471.  
  472.   4. List Customisation
  473.  
  474.      The layout of the lists can be jazzed-up with:
  475.      ■  BLOCK-title and its font
  476.      ■  TopTitle, SubTitle, BottomTitle, Include (logo-) file
  477.  
  478.  
  479.                                                               User's Guide  5
  480.  
  481.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  482.  
  483.  
  484.  
  485.      ■  Sorting sequence of area's in ALL-list (unsorted, name, include)
  486.      ■  Sorting sequence of files (unsorted, date, filename)
  487.      ■  Truncation or wrapping of file descriptions
  488.      ■  Area- or file-privilege information
  489. |    ■  Message and Warning texts
  490. |    ■  Handling of Avatar codes in comment lines (strip or mimic).
  491.  
  492.      All in the language which suites your audience best.
  493.  
  494.   The sample Downsort.CFG file (see "Appendix D.  Sample Configuration File"
  495.   on page 48) contains defaults and a brief information to help you with the
  496.   parameter specifications.
  497.  
  498.   Below you can find some more explanation.
  499.  
  500.  
  501.   3.2 DATA COLLECTION
  502.  
  503.  
  504.  
  505.   3.2.1 AREA.DAT
  506.  
  507.   A MAXIMUS file 'AREA.DAT' is absolutely required by Downsort.  It is
  508.   however not necessary to run MAXIMUS itself, the AREA.DAT file is created
  509.   with SILT(P) from the MAXIMUS package.  You can use this utility without
  510.   the other MAXIMUS stuff.  In fact I do that myself (NOT running a MAXIMUS
  511.   board)!  If you run Downsort in a directory without AREA.DAT, then you
  512.   should use specify the filespec for AREA.DAT.  It allows also to specify a
  513.   different AREA.DAT file than the one that is used by your MAXIMUS.
  514.  
  515.   With SILT(P) you may build a special AREA.DAT for exclusive use by
  516.   Downsort, with different, less, or even more directories!  Probably much
  517.   more convenient is the use of AreaINclude or AreaEXclude in Downsort.CFG to
  518.   limit the contents of the lists to a group of area's, that you want to
  519.   report together, while you use the regular AREA.DAT.  A combination of a
  520.   'special' AREA.DAT and AreaIN/EXcludes is another option to obtain
  521.   areagroups.
  522.  
  523.   Remember: The combination of area privilege in AREA.DAT and the
  524.   report-privilege specification in Downsort.CFG may restrict the contents of
  525.   reports.  AreaINclude is subordinate to this and will work only for the
  526.   collection of area's within these privilege limits.
  527.  
  528.   If Downsort reports a memory constraint (see also "6.6 Storage and
  529.   Performance" on page 32), you may use these techniques as circumvention:
  530.   exclude one or more of the file area's and rerun Downsort.
  531.  
  532.  
  533.   3.2.2 FILES.BBS
  534.  
  535.   Downsort uses the information in AREA.DAT to locate the description files,
  536.   usually called FILES.BBS.  So either the ListFile specification in
  537.   AREA.DAT, or the download directory to locate them (Maximus default).
  538.  
  539.  
  540.  
  541.  
  542.                                                               User's Guide  6
  543.  
  544.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  545.  
  546.  
  547.  
  548.   3.3 LIST TYPE SELECTION
  549.  
  550.   Downsort can produce several types of output reports, indicated by type of
  551.   list.  The following list types are available:
  552.  
  553.  
  554.   3.3.1 ORPHAN REPORT
  555.  
  556.   This is a list of all files in download directories for which there is no
  557.   entry in any FILES.BBS file of all areas which have this directory
  558.   specified as download path.  The report contains date, area-name and
  559.   area-path of the orphan.  The entries are sorted on area and filename.  Not
  560.   reported are MAXIMUS system files like: FILES.*, *.BAK, DIR.?BS and
  561.   SYSTEM*.?BS.
  562.  
  563.   If you have more than 1 area pointing to the same download directory, but
  564.   with different FILES.BBS files, the orphans are reported for the first of
  565.   these areas only.
  566.  
  567.   Note: If there is an entry for a file in FILES.BBS without a description,
  568.   the file is NOT considered to be an Orphan!
  569.  
  570.  
  571.   3.3.2 BBS-LIST
  572.  
  573.   This is a list of downloadfiles that became recently available on your
  574.   system.  File selection is on date, but for presentation the list may be
  575.   sorted on date, newest first or on filename.
  576.  
  577.   The list contains compiled MECCA control sequences, for direct use in
  578.   MAXIMUS bulletins: a user-privilege sensitive list!  It might be a good
  579.   idea to put a translated [onexit] string, which translates into: ^OFpath.
  580.   When a user exits from the BBS-list bulletin, it will fall back to the
  581.   exit-bulletin.
  582.  
  583.   The length of the file (number of file-entries) may be limited by
  584.   parameters:
  585.  
  586.   ■  file-count
  587.   ■  file age in days, weeks or months (30 days)
  588.   ■  maximum privilege
  589.  
  590.   (never more than available within the privilege limit).  If neither
  591.   specified it will contain all available files in all download directories.
  592.  
  593.   To make it easy for you to build a complete MAXIMUS bulletin-file a
  594.   user-provided header is included preceding the list and a trailer at the
  595.   end of the list.  Header and trailer can be built by SYSOP, and may contain
  596.   any information and bulletin-control sequences (a sample is provided).
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.                                                               User's Guide  7
  606.  
  607.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  608.  
  609.  
  610.  
  611.   3.3.3 NEW-LIST
  612.  
  613.   Basically the same list as above, but in simple ASCII format.  This list is
  614.   suitable for regular file-requestors as brief overview of the latest
  615.   additions, updates or replacements.
  616.  
  617.  
  618.   3.3.4 EMI-LIST
  619.  
  620.   Basically the same as NEW-list, but more compact:
  621.  
  622.   ■  contains file also file-time and exact filesize in bytes.
  623.   ■  Description wrapping (if used) is overlapping the file-details except
  624.      filename.
  625.  
  626.   The EMI-list is especially suitable to generate file-arrival messages (the
  627.   output should be included by another program).
  628.  
  629.  
  630.   3.3.5 ALL-LIST
  631.  
  632.   A list of all downloadfiles by area.  Files of the same area are listed in
  633.   groups, separated by imbedded headers with area-name, -description, and
  634.   -privilege.  Actual status information is provided in the area-header as
  635.   well: area-filecount and -bytecount, and latest acquisition (date and
  636.   file-name).
  637.  
  638.   At the end a SUMMARY report shows per area: area-title, file-count,
  639.   byte-count, and totals.
  640.  
  641.   The size of this list is limited only by the privilege parameter.  The
  642.   numbers in area-header and summary report show only what is available for
  643.   the particular privilege.
  644.  
  645.   You may generate several ALL-lists in one run!
  646.  
  647.  
  648.   3.3.6 IPF- AND IP2-LIST
  649.  
  650.   Same contents as ALL-list but in a different format.  Only useful for users
  651.   that run OS/2 (OS/2 version 1.2+ under Presentation Manager).  This file
  652.   has the format of an input-file for the Information Presentation Facility
  653.   Compiler (IPFC).
  654.  
  655.   There is a separate form of this list (called IP2-list) for OS/2 2.0.  It
  656.   produces information that can be compiled only with the accompanying IPF
  657.   Compiler of the OS/2 2.0 Toolkit.  The result however can be VIEWed under
  658.   OS/2 1.3!
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.                                                               User's Guide  8
  669.  
  670.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  671.  
  672.  
  673.  
  674.   3.3.7 GBL-LIST
  675.  
  676.   Similar to ALL-list, but where ALL-list gives the files in groups per area,
  677.   the GBL-list ignores area-boundaries and gives a single group.  It contains
  678.   an extra column with the area-code for each file, there is no area-summary.
  679.  
  680.   SYSOP may choose which of both is suitable to make available to users, and
  681.   which to use for himself (or even both).
  682.  
  683.   The GBL-list can be used in stead of the ALL-list if your users prefer
  684.   searching in the list without having to bother about area-organisation.
  685.   Although one of the original purposes of the GBL-list was checking for
  686.   duplicate files, there is now also a special report for this particular
  687.   purpose (see "3.3.8 DUP-list").
  688.  
  689.  
  690.   3.3.8 DUP-LIST
  691.  
  692.   Simple report of possibly duplicate files over the area's.  The format is
  693.   basically the same as the GBL-list, but only files with the same
  694.   filename are reported.  'Offline' files are included in the check, orphans
  695.   are not!
  696.  
  697. | Please note that the DUP-list may not always contain what you expect.  It
  698. | can be more or less, for example:
  699.  
  700. | ■  Downsort looks primarily at filenames only (extension is of second
  701. |    importance, path is completely ignored).
  702. | ■  You may have explicitly excluded area's from the search.
  703. | ■  You may have excluded area's by privilege: Downsort completely ignores
  704. |    area's with a higher privilege than any report asked for.
  705. | ■  You have duplicates in 'orphan'-state.
  706.  
  707. | These circumstances may give 'false' signals or hide duplicates!
  708.  
  709. | All duplicate files within the privilige-range will be reported, even when
  710. | a counterpart has a higher privilege or are orphan (and thus will not be
  711. | reported in the DUP-list)!  You may need a file-finder-utility to search
  712. | for the 'partner'-file in one of the directories with a higher privilege.
  713.  
  714. | There are very few other parameters applicable to this list.  File
  715. | descriptions may be specified as truncated or wrapped.  All user-titles are
  716. | left out and only a sort on filename is supported.
  717.  
  718. | Suppression of reporting files with equal filenames and different
  719. | extensions is possible with the "NonDupEXT" keyword in Downsort.Cfg.  You
  720. | specify pairs of extensions.  Two files with equal filename and one of each
  721. | having an extension specified as 'pair' will not be reported as duplicate.
  722. | For example, if you specify:
  723.  
  724. |    NonDupEXT  SDN  SDA
  725.  
  726. | then file pairs xyz.SDN and xyz.SDA will not be reported in the DUP-list.
  727.  
  728.  
  729.  
  730.  
  731.                                                               User's Guide  9
  732.  
  733.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  734.  
  735.  
  736.  
  737. | This pair-exclusion can also be used for more than 2 extensions, but the
  738. | exclusion works only for pairs of files.  So then you must specify as many
  739. | pairs as can be formed.  For example if you want to exclude file
  740. | combinations like xyz.IDX xyz.DAT and xyz.EXT, then you should specify:
  741.  
  742. |    NonDupEXT  IDX DAT  IDX EXT  DAT EXT
  743.  
  744. | Warning: The check on duplicates by Downsort works only when you specify
  745. | all  possible pairs of extensions!  If you fail to specify any possible
  746. | pair, the Dup-list may contain false signals.
  747.  
  748. | Multiple pairs may be specified on a line, and multiple lines are allowed.
  749. | Up to 100 pairs of extensions will be accepted by Downsort in total.
  750.  
  751.  
  752.   3.3.9 OKFILE
  753.  
  754.   List filespecifications for file-requests in BinkleyTerm style.  The
  755.   generated paths in the list obey the following rules:
  756.  
  757.   ■  the area-privilege is within the privilege limit of the report
  758.  
  759.   ■  the area is not excluded (by areaEXclude)
  760.  
  761.   ■  the area has at least 1 file within the privilege limit of the report
  762.  
  763.   The paths are sorted on area-name (although the area-name is not part of
  764.   the list).  There is no check on duplicate paths.
  765.  
  766.   The list is not jazzed-up with titles, etc, but a file may be included in
  767.   front of the list if specified on the OKFileList in Downsort.CFG (see
  768.   "Appendix D.  Sample Configuration File" on page 48).  This option allows
  769. | you to insert a list of 'magic' names in the OKFile.
  770.  
  771. | Two formats are available:
  772.  
  773. | ■  SHORT format with lines in the format "filepath\*.*".  This is the
  774. |    regular format for BinkleyTerm and other mailers.
  775. | ■  LONG format with lines in the format: "@filespec  filepath\filespec".
  776. |    All files have a 'magic'-name assigned and there are no generic file
  777. |    specifications in the OKFileList.  This prevents directory searches for
  778. |    BinkleyTerm for each file request.
  779.  
  780. | Note: Some newer versions of BinkleyTerm can use the file base of Maximus
  781. | to find a file even faster.
  782.  
  783.  
  784.   3.3.10 FIL-LIST
  785.  
  786.   New "FILES.BBS" type of file may be (re-)created, one for every area.  The
  787.   contents of the file-information will be about the same as the original
  788.   FILES.BBS, but with the following notes:
  789.  
  790.   ■  A header is generated with area-name, -title, and -privilege.  Also the
  791.      total amount of files and bytes and the most recently acquired new file
  792.  
  793.  
  794.                                                              User's Guide  10
  795.  
  796.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  797.  
  798.  
  799.  
  800.      in this area is part of the header information.
  801.   ■  Files with a privilege up to and including the area-privilege are listed
  802.      first.
  803.   ■  Files can have a privilege other than the area-privilege when the
  804.      original FILES.BBS file contains ^Pp-sequences ('p' being a privilege
  805.      letter).  This construction will be rebuilt by Downsort.  Files with a
  806.      higher privilege than the area-privilege will follow after a compiled
  807.      MECCA-sequence (^Pp) in the new FILES.BBS.  Downsort respects these
  808.      indicators when reading FILES.BBS, so all file-privilege information is
  809.      retained.  This ensures no accidental loss of file-information, and the
  810.      regular user won't see more than he should.
  811.   ■  Wild-card specifications in the original FILES.BBS are not propagated to
  812. |    the new FILES.BBS.
  813. | ■  The file description is kept internally as a single string of about 2
  814. |    KBytes (Maximus 2.0 supports up to 240 bytes!)  When creating FILES.BBS
  815. |    files, this will be the file format (single record per file-entry).  The
  816. |    original FILES.BBS may contain a (long) single string description, or
  817. |    multiple (short) multiline descriptions.  When encountering multiline
  818. |    descriptions in input-FILES.BBS, Downsort concatenates the separate
  819. |    description lines with a single intermediate space up to a maximum of 2
  820. |    KBytes.  This will be the output format if the FIL-list is requested.
  821. | ■  Comments in FILES.BBS will be preserved onlywhen the Keep-Sequence
  822. |    option is used (specify /K on the FilFileList line of Downsort.Cfg).
  823.  
  824. | Special attention is requested for the following:
  825.  
  826. | ■  The first 8 lines, if comments (starting with a '-'-character), are
  827. |    discarded, These are assumed to be the standard header for FILES.BBS of
  828. |    Downsort.
  829. | ■  Downsort from version 5.7 on uses the 3 characters:
  830. |    <-><&delta.><backspace> for each of its header-lines, and will skip all
  831. |    lines starting with this sequence during the data collection phase, even
  832. |    when encountered after line 8.
  833. | ■  You can include your own file with the /I-option on the FILFilePath line
  834. |    in Downsort.Cfg in the header of FILES.BBS.  All lines in the
  835. |    include-file for FILES.BBS output will be prefixed by Downsort with the
  836. |    3 character sequence mentioned above to make sure that these will also
  837. |    be 'refreshed' by Downsort.
  838.  
  839.   The destination of FILES.BBS-files is not by definition the same as the
  840.   origin!  When specified with the "FIL:"-parameter (or in the configuration
  841.   file), the output may be located in a different directory than the original
  842. | input FILES.BBS.
  843.  
  844. | When the output is directed to a separate directory, the files will be
  845. | named as follows:
  846.  
  847. | FILES.ac      when all areanames (areacodes) of the selected areas in a
  848. |               single run of Downsort are 3 bytes or less.
  849.  
  850. | areaname.BBS  when any areaname is longer than 3 bytes.
  851.  
  852. | The format of the header will be slightly different.  Font specification
  853. | (/Fx in FILFileList) works for the second case only.
  854.  
  855.  
  856.  
  857.                                                              User's Guide  11
  858.  
  859.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  860.  
  861.  
  862.  
  863.   Manual checking or post-processing by some other program may follow
  864.   Downsort, after which the files might be put back on the MAXIMUS specified
  865.   position.
  866.  
  867.  
  868.   3.4 DATA SELECTION
  869.  
  870.  
  871.  
  872.   3.4.1 PRIVILEGE CONTROL
  873.  
  874.   The default file privilege to be shown in the lists is SYSOP.  All files
  875.   with a higher privilege than the specified (or defaulted) report-privilege
  876.   will not appear in the report.
  877.  
  878.   Files without a matching filename-entry in FILES.BBS are treated as Hidden.
  879.   That means that by default these files will not be listed, unless the 'H'
  880.   privilege is used on the report-request specification.
  881.  
  882.   If you run a mailer like BinkleyTerm and support file-requests, you lack
  883.   the extensive privilege system like Maximus.  The only distiction
  884.   BinkleyTerm makes with file-request is 'unknown', 'known' and
  885.   'password-protected'.  You may generate multiple download lists with
  886.   different privilege indictor, depending if you allow these categories to
  887.   request different file collections a sample of this kind of environment is
  888.   given in "5.0 Sample of Getting organised" on page 27.
  889.  
  890.   This is not needed for Downsort.BBS, since this file has imbedded privilege
  891.   control sequences for MAXIMUS users.  But you should specify a sufficiently
  892.   high privilege for the BBS-list to satisfy your most valuable users!
  893.  
  894.  
  895.   3.4.2 AREA SELECTION
  896.  
  897.   When you need file selections on subject, you can use AreaINclude or
  898.   AreaEXclude to limit the lists to files that are part of certain
  899.   area-groups.  You should realise that this is the latest selection phase:
  900.   privilege selection has taken place already before AreaINclude or
  901.   AreaEXclude are processed.  So make sure you specified a sufficiently high
  902.   report-privilege to get the proper areas into the group.
  903.  
  904.  
  905.   3.4.3 REPORT LENGTH
  906.  
  907.   For lists that are meant to show the latest file-information only (BBS-list
  908.   and NEW-list), the length of the list can be limited to a maximum number of
  909.   file-entries or to file-age in days, weeks or months.
  910.  
  911.  
  912.   3.5 LIST CUSTOMISATION
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.                                                              User's Guide  12
  921.  
  922.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  923.  
  924.  
  925.  
  926.   3.5.1 HEADERS, TITLES AND INCLUDE FILES
  927.  
  928.   There are several ways to custimise the appearance of the lists for
  929.   Downsort.  All items in the following list are optional, but the sequence
  930.   in the reports is fixed and as listed:
  931.  
  932.   Pre-Title   Up to 20 lines as very first lines of your lists.  Any text may
  933.               be specified.  Leading '~'-characters (tilde) will be treated
  934.               as full-size required blanks, mainly to manually align (center)
  935.               the text in these lines.  There is no automatic centering.  You
  936.               may have to experiment a little.
  937.  
  938.   TITLE       A short title (8-12 characters), that will be magnified to big
  939.               BLOCK-letters.  There are 4 block-fonts to choose from.  Not
  940.               all characters are supported and lower-case will be translated
  941.               to upper-case.  The '~'-character (tilde) will be treated as
  942.               full-size required blank, the '`'-character (accent-grave) as
  943.               half-size required blank.
  944.  
  945.               If not specified, a default title is generated as Downsortxy,
  946.               where xy stands for the current version of Downsort.
  947.  
  948.   TitleFont   Number of the font to be used for the BLOCK title.  If
  949.               specified as 0, the BLOCK-title will NOT be generated at all.
  950.  
  951.   Include-file A text-file to be included.  There will be no manipulation of
  952.               the contents of this file.  This include-file may be all you
  953.               need to obtain a fully custimised list.  For the IPF-list this
  954.               include file will most likely have to contain IPF tags for
  955.               proper formatting, for the OK-file it will be a list of 'magic'
  956.               name entries.
  957.  
  958.   Sub-Title   Up to 20 lines.  These are treated like the Pre-Title lines.
  959.  
  960.   BottomTitle Up to 20 lines as very last lines of the lists.  These follow
  961.               my 'signature'.  The lines follow the same treatment as
  962.               Pre-Title lines.
  963.  
  964.   The BLOCK-title and Pre-, Sub-, and Bottom-titles are used for all reports
  965.   identically, there is no such thing as an 'individual' title specification
  966.   for each report.  However the Include-file may be different for each
  967.   report.  If you want to build more than 1 list but with different
  968.   'headings' or no headings at all, you better forget the Title-options.  In
  969.   stead make heading-files and use the Include option of the individual list
  970.   specifications.
  971.  
  972.   Note: Exceptions:
  973.  
  974.   1. None of the above does apply to the BBS-list.  As it will generally be
  975.      desirable to imbed (compiled) MECCA control sequences in this type of
  976.      lists, this report will include dedicated top and bottom files (if
  977.      available in the current default directory).  These files must be called
  978.      Downsort.HDR (header) and Downsort.TRL (trailer).
  979.  
  980.   2. The ORPHAN report will not contain any user-titles.
  981.  
  982.  
  983.                                                              User's Guide  13
  984.  
  985.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  986.  
  987.  
  988.  
  989.   3. The FILES.bbs files will not use any of the title-specifications, but
  990.      may use an Include-file.
  991.  
  992.   Recommendation: File-requestors appreciate a header with a clear indication
  993.   of the source of the reports.  Many Bulletin Boards use FILES or ALLFILES
  994.   as 'magic' name, but that is not very distinctive if you collect lists of
  995.   different boards!  So use Downsort's facilities to generate a block-title
  996.   with your system-name, or an include file with some kind of logo.
  997.  
  998.   Note: Specification details and samples can be found in Downsort.CFG.
  999.  
  1000.   Some SYSOPs do not like to confront their users with privileges.  In most
  1001.   headers there will be a line with the reporting privilege.  This may be
  1002.   suppressed.
  1003.  
  1004.  
  1005.   3.5.2 FILE SORTING
  1006.  
  1007.   The file-entries in the lists can be sorted on different keys:
  1008.  
  1009.   ■  Filedate
  1010.  
  1011.   ■  Filename
  1012.  
  1013.   ■  Sequence of FILES.BBS
  1014.  
  1015.   The default sorting sequence depends on the type of list.  Some lists do
  1016.   not support some of these sorting keys.
  1017.  
  1018.   Note: File sorting has a local scope.  It can be specified for to each
  1019.   listtype individually.
  1020.  
  1021.  
  1022.   3.5.3 AREA SORTING
  1023.  
  1024.   The order in which the areas are presented in the lists can be specified:
  1025.  
  1026.   ■  Order of AREA.DAT
  1027.   ■  Sorted alphabetically on areaname
  1028.   ■  Order of areaINclude statement in Downsort.Cfg
  1029.   ■  Groupname-order
  1030.  
  1031.   The Groupname-order is a special order based on a popular naming convention
  1032.   for areas.  Many SYSOPs use areanames with a group-name or -letter followed
  1033.   by a sequence number.  With groupname sorting the areaname is split - if
  1034.   possible - into a groupname (if the first character is not be numeric) and
  1035.   a sequence number (if the last part of areaname is numeric).  Primary sort
  1036.   key is groupname, secundary sortkey is sequence number.  If the first
  1037.   character of the area-name is numeric, the groupname is empty, and if the
  1038.   last part of the areaname is not numeric, the second key is empty.
  1039.  
  1040.   If the ordering does not match your more complicated area naming
  1041.   convention, you can always fallback on a properly sequenced AREA.DAT, or on
  1042.   areaINclude sequence.
  1043.  
  1044.  
  1045.  
  1046.                                                              User's Guide  14
  1047.  
  1048.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1049.  
  1050.  
  1051.  
  1052.   If Include-order is specified, but AreaINclude is not, then the order falls
  1053.   back to Group-order.
  1054.  
  1055.   The area-order specification has a global scope.  It applies to every lists
  1056.   where the areaname is significant, including summaries in ALL- and
  1057.   IPF-lists.
  1058.  
  1059.   Default sorting order is 'Group'.
  1060.  
  1061.  
  1062.   3.5.4 WARNINGS, INDICATIONS, DESCRIPTIONS AND COMMENTS
  1063.  
  1064.   ■  There are two options for long file descriptions (those that do not fit
  1065.      on a 80-character line):
  1066.      ∙  Truncation at end-of-line
  1067.      ∙  Wrapping to multiple lines
  1068.  
  1069.      Both options are available for all lists, but the defaults vary with the
  1070.      type of the report.
  1071.  
  1072.   ■  Orphan description: Text that will be reported in the description column
  1073.      of a file, when for this file no entry in FILES.BBS could be located.
  1074.  
  1075.      Default: "--- Orphan ---".
  1076.  
  1077.   ■  Not-Found description: Text for the description column when the
  1078.      file-entry was found in FILES.BBS, but there was no description present.
  1079.  
  1080.      Default: "--- no description available ---".
  1081.  
  1082.   ■  Offline description: Text that will replace file-size and file-date,
  1083.      when an entry for this file was found in FILES.BBS, but the file could
  1084.      not be located in the download directory.
  1085.  
  1086.      Default: "** offline **".
  1087.  
  1088.   ■  Comments in FILES.BBS (mostly used for additional description for groups
  1089.      of files) will be listed when no sorting is specified (the /K option for
  1090. |    ALL-, IPF- and FIL-lists).
  1091.  
  1092. |    When Downsort encounters Avatar screen handling codes in FILES.BBS these
  1093. |    are stripped of or partially imitated in the output lists (unless
  1094. |    AVAstrip No is specified in Downsort.Cfg).  Typical screen handling
  1095. |    commands (cursor movement, color settings) are just stripped, ohers
  1096. |    (repeating characters of patterns) are imitated.
  1097.  
  1098.   ■  Size of a VIEW-page in IPF-list: The IPF-list of area's with more than
  1099.      250 file entries will be splitted into 'parts' to prevent the
  1100.      IPF-compiler message 'page size exceeded'.  But if you have many long
  1101.      descriptions, or wish smaller parts, the page-size can be altered with a
  1102.      parameter on the IpfFileList line in Downsort.CFG.
  1103.  
  1104.      Default: 250.
  1105.  
  1106.  
  1107.  
  1108.  
  1109.                                                              User's Guide  15
  1110.  
  1111.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1112.  
  1113.  
  1114.  
  1115.   3.6 MISCELLANEOUS REPORT INFORMATION
  1116.  
  1117.  
  1118.  
  1119.   3.6.1 FILE INFORMATION IN LISTS
  1120.  
  1121.   1. Dates are marked with a 'new'-indicator: a '*' if the file is only since
  1122.      a week on this system, and a '+' if it is since a month.  Filedates
  1123.      later than the current system date are marked '-' (negative age).
  1124.  
  1125.   2. In every outputfile the filename, MAXIMUS-area name, file-size and
  1126.      -date, and file-description from FILES.BBS is listed.  A report-line
  1127.      will never display more than 79 characters.
  1128.  
  1129.      The file-description will be multi-line in ALL-, IPF- and GBL-list if it
  1130.      is longer than would fit on the standard 79-position line, a
  1131.      word-wrapping technique is used for readability (line-split on word
  1132.      boundary).  The description is truncated at end of line in BBS-list and
  1133.      NEW-list.
  1134.  
  1135.      The -T option will force truncation of the description in all reports,
  1136.      the -W option will allow multi-line descriptions in all reports.
  1137.  
  1138.      If a filename is found in FILES.BBS, but no accompanying description, a
  1139.      "--- no description available ---" will be put in place.  An alternative
  1140.      text may be specified with Downsort.CFG.
  1141.  
  1142.      Files for which there is no entry in the FILES.BBS (Orphans) are treated
  1143.      as Hidden files, which are only listed in the reports if the Hidden
  1144.      privilege is specified.
  1145.  
  1146.      Note: If you want the orphans to appear in FILES.BBS (or in any other
  1147.      report), you MUST also request an ORP-list!
  1148.  
  1149.   3. 'OFFLINE" in stead of file-size and file-date is reported if FILES.BBS
  1150.      contains an file-entry while the file is not in the corresponding
  1151.      directory.
  1152.  
  1153.   4. The BBS-list contains MAXIMUS authorisation controls (^PLp-sequences),
  1154.      corresponding to the privilege of the area or the individual file.  So
  1155.      it is not necessary to make different files for different categories of
  1156.      MAXIMUS users, even with the default privilege-limit SYSOP a user will
  1157.      not see the files he/she is not supposed to know about.
  1158.  
  1159.      Other lists do not contain any privilege information, the files (or
  1160.      complete area's) above the specified privilege are simply not listed,
  1161.      however multiple lists can be produced for different categories of users
  1162.      (based on privilege).
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.                                                              User's Guide  16
  1173.  
  1174.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1175.  
  1176.  
  1177.  
  1178.   3.6.2 FILE DATES
  1179.  
  1180.   One of the function of Downsort is sorting on file date.  Since the
  1181.   introduction of HPFS in OS/2 version 1.2, there is not one single file-date
  1182.   anymore!  A file on an HPFS volume has different values for:
  1183.  
  1184.   ■  Creation date
  1185.   ■  LastAccess date
  1186.   ■  LastWrite date
  1187.  
  1188.   The date you see normally in DIR-listings is the LastWrite date.  Most
  1189.   SYSOPs will have noticed that ZMODEM uploads and file-attaches give
  1190.   file-dates corresponding to the (LastWrite-) date of the sending system.
  1191.   And most utilities handle only this 'single' date.  That means that old
  1192.   ZMODEM-uploaded files are generally not on top of the acquisition lists.
  1193.  
  1194.   But HPFS stores the date of arrival on your system (Creation) as well.
  1195.   Downsort handles the Creation date for sorting, but the lists (see below)
  1196.   contain the 'old fashioned' LastWrite date.  This has the following
  1197.   consequences:
  1198.  
  1199.   ■  A new acquisition is on top of lists, if that list is sorted on date,
  1200.      and are marked in the lists as new by a flag for an 'age' of a week or a
  1201.      month.
  1202.   ■  The listed file-date is the 'ordinary' date.  So users can judge for
  1203.      themselves if the file is 'new' for them as well.
  1204.  
  1205.   Note: The LastAccess date is not very relevant for the purposes of
  1206.   Downsort, although SYSOP may see when it was last downloaded.
  1207.  
  1208.   Downsort is delivered with a simple DIR-like utility 'HPFSDATE' to show the
  1209.   three dates of a file on a HPFS volume.
  1210.  
  1211.  
  1212.   3.6.3 DUPLICATES
  1213.  
  1214.   Duplicate filenames are checked if the DUP-list is requested, and they will
  1215.   be reported only in the DUP-list.  So duplicates may appear in the regular
  1216.   user-lists, which means:
  1217.  
  1218.   ■  If a filename.ext is encountered more than once in different
  1219.      subdirectories of FILES.BBS files, it will appear that many times in the
  1220.      outputlist.  The file-privilege reflects that of the area where the file
  1221.      belongs to, unless overridden by a ^Px modifier in FILES.BBS.
  1222.   ■  It may happen that a file is reported as orphan in one area, and as
  1223.      duplicate in another.  It is likely that the file is found in a common
  1224.      download directory of more than one area but it is described in the
  1225.      FILES.BBS of a 'secundary' area, but with the wrong extension.
  1226.  
  1227.  
  1228.  
  1229.  
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235.                                                              User's Guide  17
  1236.  
  1237.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1238.  
  1239.  
  1240.  
  1241.   4.0 PARAMETER SPECIFICATIONS
  1242.  
  1243.   This chapter tells you how to customise the configuration file and what you
  1244.   might specify on the commandline.
  1245.  
  1246.   A sample configuration file (in "Appendix D.  Sample Configuration File" on
  1247.   page 48) is part of the package.  It contains a brief comments (in Binkley
  1248.   and MAXIMUS style) to help you.
  1249.  
  1250.  
  1251.   4.1 COMMANDLINE PARAMETERS
  1252.  
  1253.   This paragraph deals only with the commandline parameters!
  1254.  
  1255.   NOTE: Parameters from Downsort.CFG are processed first, commandline
  1256.   parameters may complete and (partly) override those in the configuration
  1257.   file.
  1258.  
  1259.   An explanation of how to read the command syntax diagram can be found in
  1260.   the (online) OS/2 Command Reference manual.
  1261.  
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.  
  1268.  
  1269.  
  1270.  
  1271.  
  1272.  
  1273.  
  1274.  
  1275.  
  1276.  
  1277.  
  1278.  
  1279.  
  1280.  
  1281.  
  1282.  
  1283.  
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.                                                  Parameter Specifications  18
  1299.  
  1300.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1301.  
  1302.  
  1303.  
  1304.  
  1305.                                         ┌────────────────────────┐
  1306.                                         v                        │
  1307.    ──┬─────────┬─┬────────┬─ Downsort ────┬────────────────────┬─┴─────┤
  1308.      └─ drive ─┘ └─ path ─┘               ├─ @filespec ────────┤
  1309.                                           ├─ BBS ─┬──────┬─────┤
  1310.                                           │       └─
  1311.  
  1312.    ─┘     │
  1313.                                           ├─ NEW ─┬───────┬────┤
  1314.                                           │       └─ :pp ─┘    │
  1315.                                           ├─ EMI ─┬───────┬────┤
  1316.                                           │       └─ :pp ─┘    │
  1317.                                           ├─ ALL ─┬───────┬────┤
  1318.                                           │       └─ :pp ─┘    │
  1319.                                           ├─ IPF ─┬───────┬────┤
  1320.                                           │       └─ :pp ─┘    │
  1321.                                           ├─ IP2 ─┬───────┬────┤
  1322.                                           │       └─ :pp ─┘    │
  1323.                                           ├─ GBL ─┬───────┬────┤
  1324.                                           │       └─ :pp ─┘    │
  1325.                                           ├─ DUP ─┬──────┬─────┤
  1326.                                           │       └─
  1327.  
  1328.    ─┘     │
  1329.                                           ├─ OK ──┬──────┬─────┤
  1330.                                           │       └─
  1331.  
  1332.    ─┘     │
  1333.                                           ├─ ORP ──────────────┤
  1334.                                           ├─ FIL ─┬──────────┬─┤
  1335.                                           │       └─ :fpath ─┘ │
  1336.                                           ├─ nnn ─┬────────────┤
  1337.                                           │       └── D|W|M ───┤
  1338.                                           ├──┬─ /T ─┬──────────┤
  1339.                                           │  └─ /W ─┘          │
  1340.                                           ├──┬─ /A ─┬──────────┤
  1341.                                           │  ├─ /D ─┤          │
  1342.                                           │  └─ /K ─┘          │
  1343.                                           ├──── /L ────────────┤
  1344.                                           ├──┬─ /H ─┬──────────┤
  1345.                                           │  ├─ /Q ─┤          │
  1346.                                           │  └─ /V ─┘          │
  1347.                                           └──── /X ────────────┘
  1348.  
  1349.   @filespec   The character '@' followed by a complete file
  1350.               specification of the Downsort configuration file(see "4.3
  1351.               Configuration file Parameters" on page 25 for details).  This
  1352.               file will be used to specify processing parameters.  If the
  1353.               file cannot be read, only the commandline parameters are used.
  1354.  
  1355.               NOTE: The use of a configuration file is mandatory when the
  1356.               file AREA.DAT is not in the default directory when running
  1357.               Downsort.
  1358.  
  1359.  
  1360.  
  1361.                                                  Parameter Specifications  19
  1362.  
  1363.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1364.  
  1365.  
  1366.  
  1367.               Default: Downsort.CFG in current default directory.
  1368.  
  1369.   BBS         Create the BBS-list: Downsort.BBS.
  1370.  
  1371.               Default: Downsort.BBS will not be created.
  1372.  
  1373.   NEW         Create NEW-list(s): Downsort.N~p, where 'p' is the appropriate
  1374.               privilege class (see below).
  1375.  
  1376.               Default: Downsort.N~p will not be created.
  1377.  
  1378.   EMI         Create EMI-list(s): Downsort.E~p, where 'p' is the appropriate
  1379.               privilege class (see below).
  1380.  
  1381.               Default: Downsort.E~p will not be created.
  1382.  
  1383.   ALL         Create ALL-list(s): Downsort.A~p, where 'p' is the appropriate
  1384.               privilege class (see below).
  1385.  
  1386.               nnn-limit does not apply to ALL-list.
  1387.  
  1388.               Default: Downsort.A~p will not be created.
  1389.  
  1390.   IPF         Create IPF-list(s): Downsort.I~p, where 'p' is the appropriate
  1391.               privilege class (see below).
  1392.  
  1393.               nnn-limit does not apply to IPF-list.
  1394.  
  1395.               Default: Downsort.I~p will not be created.
  1396.  
  1397.   IP2         Create IP2-list(s): Downsort.I~p, where 'p' is the appropriate
  1398.               privilege class (see below).
  1399.  
  1400.               nnn-limit does not apply to IP2-list.
  1401.  
  1402.               Default: Downsort.I~p will not be created.
  1403.  
  1404.   GBL         Create GBL-list(s): Downsort.G~p, where 'p' is the appropriate
  1405.               privilege class (see below).
  1406.  
  1407.               nnn-limit does not apply to GBL-list.
  1408.  
  1409.               Default: Downsort.G~p will not be created.
  1410.  
  1411.   DUP         Create DUP-list(s): Downsort.DUP.
  1412.  
  1413.               Only the privilege-specification and WRAP/TRUNC flag apply to
  1414.               DUP-list.
  1415.  
  1416.               Default: Downsort.DUP will not be created.
  1417.  
  1418.   OK          Create OKFile(s): Downsort.O~p.
  1419.  
  1420.               Only the privilege(s) and include-file specifications apply to
  1421.               the OKFile.
  1422.  
  1423.  
  1424.                                                  Parameter Specifications  20
  1425.  
  1426.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1427.  
  1428.  
  1429.  
  1430.               Default: Downsort.O~p will not be created.
  1431.  
  1432.   ORP         Create ORP-list: Downsort.ORP (orphan report, if any orphans).
  1433.  
  1434.               If an orphan report is not requested, no other report will
  1435.               contain any orphan information, even when 'Hidden' is specified
  1436.               as reporting level.
  1437.  
  1438.               Default: Downsort.ORP will not be created.
  1439.  
  1440.   FIL         Create FILES.BBS type of files for each area.
  1441.  
  1442.               The specification does not apply to FILES.BBS, a
  1443.               privilege-limit cannot be specified and defaults to SYSOP.
  1444.               Another privilege limit can be specified however by means of
  1445.               the configuration file.
  1446.  
  1447.               For each individual area the following convention will be used
  1448.               for the name and place of the FILES.BBS list (in this
  1449.               sequence):
  1450. |             1. If the "FIL:" parameter specifies a directory-path, then the
  1451. |                output-'FILES.BBS'-files of all areas are put in this
  1452. |                directory with the following naming convention:
  1453. |                a. When the length of any reported areaname is longer than 3
  1454. |                   characters, all outputfiles will be called
  1455. |                   'areaname.BBS', where "areaname" is the name of the area
  1456. |                   according to Maximus' AREA.DAT.
  1457. |                b. Otherwise the outputfile will be called "FILES.ac", where
  1458. |                   'ac' is the areaname.  This is the 'old' naming
  1459. |                   convention (before version 5.7) of Downsort.
  1460.  
  1461. |                In other words: only one of both naming conventions will be
  1462. |                used during a single run of Downsort, and if none of the
  1463. |                reported area's has a name longer than 3 characters it will
  1464. |                be the 'old' convention for all.
  1465.  
  1466.                  Previous files in this directory with the same name will be
  1467.                  discarded.
  1468.               2. If "ListFile" is specified in Maximus' AREA.CTL file, then
  1469.                  that name and path will be used.
  1470.               3. Otherwise the file FILES.BBS: will be put in the directory
  1471.                  with the download files.
  1472.  
  1473.               For situations 2 and 3 existing files will be renamed to .BAK
  1474.               (older .BAK files will be discarded).
  1475.  
  1476.               Default: FILES.BBS-type of files will not be generated.
  1477.  
  1478.   fpath       Optional directory path specification for FILES.BBS-output.
  1479.               See the "FIL:" parameter for usage.
  1480.  
  1481.               Default: none
  1482.  
  1483.   nnn[P]      If 'nnn' is specified sec (without a trailing letter), then it
  1484.               is the maximum number of files to be reported in the BBS- and
  1485.  
  1486.  
  1487.                                                  Parameter Specifications  21
  1488.  
  1489.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1490.  
  1491.  
  1492.  
  1493.               NEW-list(s).  When followed by a character (only D, W and M are
  1494.               allowed), then 'nnn' specifies the maximum age of the files in
  1495.               number of Days, Weeks or Months, to be included in NEW- and
  1496.               BBS-lists.  A maximum value of 32767 can be specified.
  1497.  
  1498.               Default: all files up to and including the (specified or
  1499.               default) privilege class will be listed..
  1500.  
  1501.   p           Single privilege character.
  1502.  
  1503.               Lists only download files with a privilege of up to and
  1504.               including privilege 'p'.  The indicator must be the first
  1505.               character of an existing MAXIMUS privilege level (T, D, L, N,
  1506.               W, P, F, E, C, A, S, H).  No error-message is given for an
  1507.               invalid privilege character, there will simply be no file-list
  1508.               for an invalid character!
  1509.  
  1510.               For the BBS-list and DUP-list only a single privilege character
  1511.               is allowed, the files lists will get the extension of BBS and
  1512.               DUP respectively.
  1513.  
  1514.               Default: S  (SYSOP):  files of all privilege levels will be
  1515.               listed, except HIDDEN files (with real Hidden privilege or
  1516.               files for which no entry could be found in FILES.BBS).
  1517.  
  1518.   pp          Multiple privilege characters (minumum 0, maximum 10).
  1519.  
  1520.               Make for every valid specified privilege level a download-list
  1521.               with files of a privilege of up to and including privilege 'p'.
  1522.               The indicator must be the first character of an existing
  1523.               MAXIMUS privilege level.  No error-message is given for an
  1524.               invalid privilege character, there will simply be no file-list
  1525.               for an invalid character!
  1526.  
  1527.               Applies to ALL-, GBL-, IPF-, NEW- and OK-lists, these are
  1528.               called Downsort.A~p, Downsort.G~p, Downsort.I~p, Downsort.N~p
  1529.               and Downsort.O~p respectively, were 'p' represents the
  1530.               applicable privilege character.
  1531.  
  1532.               Default: S  (SYSOP):  files of all privilege levels will be
  1533.               listed, except HIDDEN files (with real Hidden privilege or
  1534.               files for which no entry could be found in FILES.BBS).
  1535.  
  1536.   /T /W       Action to be taken if the file description would cause the
  1537.               reportline to exceed 79 characters:
  1538.               ■  T - truncate the description
  1539.               ■  W - wrap the description and provide as many reportlines as
  1540.                  needed to show the complete description.
  1541.  
  1542.               Default: -T for NEW-list and BBS-list, -W for ALL-, IPF- and
  1543.               GBL-list.
  1544.  
  1545.   /A /D /K    Sorting method.
  1546.               ■  A - Sort the files alphabetically on filename.
  1547.               ■  D - Sort the files on reversed date sequence (newest file on
  1548.  
  1549.  
  1550.                                                  Parameter Specifications  22
  1551.  
  1552.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1553.  
  1554.  
  1555.  
  1556.                  top of list).
  1557.               ■  K - keep lines in sequence of FILES.BBS and keep the
  1558.                  interfile comment lines.
  1559.  
  1560.               When the -A option is selected, an additional header-line will
  1561.               appear in the BBS-list and NEW-list, indicating the latest
  1562.               acquisition.  This line is not needed and will not be done when
  1563.               these lists are sorted on date, since the the latest
  1564.               acquisition will be on top of the list!
  1565.  
  1566.               The -K option is useful in situations where the files are
  1567.               primarily grouped on AREA, i.c. ALL-, IPF- and FIL-list.
  1568.  
  1569.               If and only if this option specified, any imbedded comments in
  1570.               FILES.BBS are copied to the ALL-, IPF- and/or FILES.bbs-files.
  1571.  
  1572.               Default: -K for FILES.BBS, -D for BBS- and NEW-files, -A for
  1573.               other.
  1574.  
  1575.   /L          Generate a LONG OKfile with explicit filenames, rather than a
  1576. |             list with generic file specifications (path\*.*).  For
  1577. |             FILES.BBS output it means that file size and file date will be
  1578. |             included for every file.
  1579.  
  1580.   /H /Q /V    Operating mode
  1581.               ■  H - help:  display screen with essential information about
  1582.                  running Downsort, such as the command syntax.  In that case
  1583.                  the program will not undertake any other action.
  1584.               ■  Q - quiet:  display only start and finish-message, and error
  1585.                  messages which prevent the program from proceeding normally.
  1586.               ■  V - verbose:  display a lot of progress messages.
  1587.               If neither -Q nor -V is specified, than the number of console
  1588.               messages will be 'intermediate': more than -Q, but less than
  1589.               -V.
  1590.  
  1591.               Default: none
  1592.  
  1593.   /X          Exclude Privilege Indications
  1594.               ■  X - exclude privilege indications in all list-types.  Some
  1595.                  SYSOPs want to hide any kind of privilege-system for users
  1596.                  and file-requesters of their Bulletin Board System.  With
  1597.                  the -X option specified all privilege indications will be
  1598.                  suppressed.
  1599.  
  1600.                  Note: This does not apply to the compiled MECCA privilege
  1601.                  controls in the BBS-list!
  1602.  
  1603.               Default: none (privilege indications will be reported).
  1604.  
  1605.  
  1606.  
  1607.  
  1608.  
  1609.  
  1610.  
  1611.  
  1612.  
  1613.                                                  Parameter Specifications  23
  1614.  
  1615.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1616.  
  1617.  
  1618.  
  1619.   4.2 HINTS FOR SPECIFICATIONS
  1620.  
  1621.   1. All commandline parameters are optional, may be specified in any
  1622.      sequence and are case independent.
  1623.  
  1624.   2. Parameters from the configuration file are processed before those from
  1625.      the commandline.  This has some side-effects, like:
  1626.      ■  If you specify a specific list in Downsort.Cfg, it will be created
  1627.         anyhow, whatever you specify on the commandline.
  1628.      ■  However, if you specify privilege values on the commandline, only the
  1629.         commandline values will be used, and none from the configuration
  1630.         file.
  1631.      ■  Commandline parameters have a global meaning, and are applied to all
  1632.         lists (if applicable).  For example: if you specify '-A' on the
  1633.         commandline, all lists will be sorted alphabetically on filename.
  1634.  
  1635.   3. Parameters that can be specified with the configuration file only, and
  1636.      cannot be overridden with a commandline parameter are:
  1637.      ■  BLOCK title-text and -font
  1638.      ■  Other titles
  1639.      ■  Filename and individual list-options
  1640.      ■  Privilege for FILES.BBS output
  1641.      ■  Replacements of some warnings and messages that may appear in the
  1642.         lists.
  1643.  
  1644.   4. Even when specified on the commandline, or in Downsort.CFG, the
  1645.      Orphan-report will be generated only if there are any orphans, and then
  1646.      the specified parameters apply.
  1647.  
  1648.   5. The IPF-list has to be processed by the Information Presentation
  1649.      Facility Compiler (IPFC).  This compiler is part of the IBM Programmers
  1650.      Development Toolkit version 1.2 and 1.3. For the IP2-list the OS/2 2.0
  1651.      or 2.1 toolkit is needed.  The following command has to be issued:
  1652.  
  1653.       IPFC  Downsort.IPF  /INF
  1654.  
  1655.      The option "/INF" is essential (but not documented!) to obtain a
  1656.      viewable file.  Be also sure to have the file Downsort.BMP in your
  1657.      current default directory, or in DPATH, as this will be imbedded by the
  1658.      IPF-compiler.  The result of the compilation is a file Downsort.INF,
  1659.      which can be VIEWed with the following command:
  1660.  
  1661.       VIEW  Downsort
  1662.  
  1663.      Note:
  1664.      ■  The names "Downsort", "IPF" and "INF" are used here as sample,
  1665.         actually the filename depends on the specification in the Downsort
  1666.         configuration file, the extensions are the IPFC defaults.
  1667.      ■  If VIEW gives garbled columns and hardly readable block-titles, then
  1668.         it is most likely that you did not install (or removed) the standard
  1669.         fonts that are delivered with OS/2.  Start the 'control panel
  1670.         utility', select 'installation', 'add fonts'.  Specify in the
  1671.         'from'-field C:\OS2\DLL (see HELP of control panel).  Now choose at
  1672.         least 1 non-proportional font.
  1673.  
  1674.  
  1675.  
  1676.                                                  Parameter Specifications  24
  1677.  
  1678.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1679.  
  1680.  
  1681.  
  1682.   4.3 CONFIGURATION FILE PARAMETERS
  1683.  
  1684.   Almost all processing options may be specified in a configuration file.
  1685.   This is a somewhat more convenient way to specify processing parameters,
  1686.   and provides even more customisation posibilities for the lists.  It is a
  1687.   good place for the more static parameters of your environment.  Commandline
  1688.   parameters are nice to create quickly 'another' list or a different format
  1689.   (for example wrapped or truncated descriptions).  The parameters are only
  1690.   mentioned here for completeness, see "Appendix D.  Sample Configuration
  1691.   File" on page 48 for a documented specification sample of a configuration
  1692.   file.
  1693.  
  1694.  
  1695.   4.3.1 PARAMETERS WITH GLOBAL SCOPE
  1696.  
  1697.   The parameters below influence the execution of Downsort, or have impact on
  1698.   every list (if it is applicable for that list).
  1699.  
  1700.   ■  File Specification of the MAXIMUS CBCS file 'AREA.DAT'.
  1701.   ■  Area Selection
  1702.   ■  Sorting order of areas
  1703.   ■  List title with BLOCK-characters.
  1704.   ■  Font for the BLOCK title.
  1705.   ■  Pre-titles, Sub-titles and Bottom-lines in 'text' format
  1706.   ■  Descriptive text of orphans, files without a description and files for
  1707.      which an entry is found in FILES.BBS, but could not be found in the
  1708.      corresponding download directory.
  1709.   ■  Maximum number of entries in NEW-list and BBS-list.
  1710.  
  1711.  
  1712.  
  1713.   4.3.2 PARAMETERS WITH LOCAL SCOPE
  1714.  
  1715.   The parameters below are sub-parameters of the xxxFileList keyword.
  1716.  
  1717.   ■  Up to 10 privileges for NEW-, GBL-, ALL- and IPF-list (each resulting in
  1718.      a separate list).
  1719.   ■  Alternate output filename (in stead of the default Downsort).
  1720.   ■  Directory for the output FILES.BBS-lists
  1721.   ■  Maximum number of file entries in NEW-list and BBS-list
  1722.   ■  File-entry sort sequence (filename or date).
  1723.   ■  Wrap or Truncate long file descriptions.
  1724.   ■  Title Font selection.
  1725.   ■  Suppression of privilege indications in NEW-, ALL-, IPF- and GBL-lists.
  1726.   ■  Include textfile in NEW-, ALL-, IPF- and GBL-lists, and in FILES.bbs.
  1727.  
  1728.   Downsort can generate several lists in a single run, but processes only the
  1729.   specifications of a single xxxFileList of the same type.  If you need
  1730.   different layouts, for example an ALL-list with files sorted on date, and
  1731.   another ALL-list with files sorted on filename, then you would need 2
  1732.   invocations of Downsort with different configuration files.
  1733.  
  1734.   If you specify more than one xxxFileList line of the same type, then the
  1735.   paramaters of each of the lines are 'mixed': some will be overwritten, some
  1736.   others will remain there from previous specifications.  It will probably
  1737.  
  1738.  
  1739.                                                  Parameter Specifications  25
  1740.  
  1741.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1742.  
  1743.  
  1744.  
  1745.   give unwanted effects!
  1746.  
  1747.   A sample configuration file is provided.  A listing of this file is
  1748.   imbedded as "Appendix D.  Sample Configuration File" on page 48.  It
  1749.   contains a complete specification with comments on:
  1750.  
  1751.   ■  which options are available
  1752.   ■  how to specify the options
  1753.  
  1754.   Read and modify the file as you like.  Copy the sample file to a save place
  1755.   before you start modifying the original Downsort.CFG!
  1756.  
  1757.   NOTE: The parameters from Downsort.CFG are processed first, then
  1758.   commandline parameters, which may complete and will (partly) override those
  1759.   in the configuration file.
  1760.  
  1761.  
  1762.  
  1763.  
  1764.  
  1765.  
  1766.  
  1767.  
  1768.  
  1769.  
  1770.  
  1771.  
  1772.  
  1773.  
  1774.  
  1775.  
  1776.  
  1777.  
  1778.  
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784.  
  1785.  
  1786.  
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.  
  1793.  
  1794.  
  1795.  
  1796.  
  1797.  
  1798.  
  1799.  
  1800.  
  1801.  
  1802.                                                  Parameter Specifications  26
  1803.  
  1804.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1805.  
  1806.  
  1807.  
  1808.   5.0 SAMPLE OF GETTING ORGANISED
  1809.  
  1810.   Assume you are runnung MAXIMUS with BinkleyTerm as front end mailer.
  1811.   Suppose you make a distinction for file-requestors between Unknown, Known
  1812.   and Password-Protected (e.g. corresponding to Disgrace, Normal and
  1813.   Privileged MAXIMUS users).
  1814.  
  1815.  
  1816.   5.1 DOWNSORT
  1817.  
  1818.   You might have a specification like this:
  1819.  
  1820.     Downsort bbs
  1821.  
  1822.    new:dnp all:dnp 100
  1823.  
  1824.   In addition to or in place of the specifications in Downsort.CFG, this
  1825.   specification produces the following lists:
  1826.  
  1827.   ■  Orphan report (only if there are any orphans).
  1828.  
  1829.   ■  Downsort.BBS with 100 entries for MAXIMUS users of category Privil.
  1830.      Users with a lower privilege will actually see a shorter list if the
  1831.      file contains Privil entries.
  1832.  
  1833.   ■  For file requestors of the magic filename FILES a list, a list with all
  1834.      files (with optional titles via Downsort.CFG specifications):
  1835.      ∙  Downsort.A~D for UNKNOWN file-requestors
  1836.      ∙  Downsort.A~N for KNOWN file-requestors
  1837.      ∙  Downsort.A~P for Password Protected file-requestors
  1838.  
  1839.      Note that each list is a complete list of what is available to the user
  1840.      of the specific privilege class, but your system will generally contain
  1841.      more files than listed for UNKNOWN and KNOWN users!
  1842.  
  1843.   ■  For file requests of the magic filename NEWFILES a list of the 100 most
  1844.      recent additions to your system (with optional titles via Downsort.CFG
  1845.      specifications):
  1846.      ∙  Downsort.N~D for UNKNOWN file-requestors
  1847.      ∙  Downsort.N~N for KNOWN file-requestors
  1848.      ∙  Downsort.N~P for Password Protected file-requestors
  1849.  
  1850.      Note that each list is 100 entries long, but the contents will generally
  1851.      not be quite the same (depending on your privilege strategy).
  1852.  
  1853.   In general: files, which the requestor is not supposed to know about due to
  1854.   his privilege status, will not be on his/her list!
  1855.  
  1856.   Note: The counters on top of the lists indicate what your system has
  1857.   available in total (including higher privileges), so a clever
  1858.   user/file-requester may come up with the question how that is possible:
  1859.   explain that he/she has to earn a higher privilege level!
  1860.  
  1861.  
  1862.  
  1863.  
  1864.  
  1865.                                               Sample of Getting organised  27
  1866.  
  1867.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1868.  
  1869.  
  1870.  
  1871.   5.2 BINKLEYTERM
  1872.  
  1873.   In Binkley.Cfg you should specify for requests of FILES:
  1874.  
  1875.     Avail        Downsort.A~d
  1876.     KnownAvail   Downsort.A~n
  1877.     ProtAvail    Downsort.A~p
  1878.  
  1879.   Furthermore you may need to specify different OKFILEs:
  1880.  
  1881.     OKFile       Download.N
  1882.     KnownReqList Download.K
  1883.     ProtReqList  Download.P
  1884.  
  1885.   And in each of the appropriate filerequest authorisation files you should
  1886.   specify the appropriate file-spec:
  1887.  
  1888.  
  1889.    ╔═══════════╦══════════════╦═══════════════╦═══════════════╗
  1890.    ║       in: ║ OKFile       ║ KnownReqList  ║ ProtReqList   ║
  1891.    ║           ║ (Download.N) ║ (Download.K)  ║ (Download.P)  ║
  1892.    ║ for:      ║              ║               ║               ║
  1893.    ╠═══════════╬══════════════╬═══════════════╬═══════════════╣
  1894.    ║ .....     ║ .........    ║ ...........   ║  ........     ║
  1895.    ║ @NEWFILES ║ Downsort.N~d ║ Downsort.N~n  ║  Downsort.N~p ║
  1896.    ║ @FILES    ║ Downsort.A~d ║ Downsort.A~n  ║  Downsort.A~p ║
  1897.    ║ .....     ║ .........    ║ ...........   ║  ........     ║
  1898.    ╚═══════════╩══════════════╩═══════════════╩═══════════════╝
  1899.  
  1900.   This will result in sending of the appropriate NEW-list to every requester
  1901.   of the magic filename: NEWFILES.  If you use the second magic filename,
  1902.   then the Avail-lines in Binkley.Cfg are not needed, and you might prefer
  1903.   this way.
  1904.  
  1905.   Of course if the privilege level of all download area's is the same, this
  1906.   construction is not needed, but in that case it is unlikely that you have
  1907.   specified KnownAvail and ProtAvail!
  1908.  
  1909.   Downsort may create a set of OK-files for you.  The privilege system of
  1910.   MAXIMUS CBCS is used to select the download paths in this list.
  1911.  
  1912.  
  1913.  
  1914.  
  1915.  
  1916.  
  1917.  
  1918.  
  1919.  
  1920.  
  1921.  
  1922.  
  1923.  
  1924.  
  1925.  
  1926.  
  1927.  
  1928.                                               Sample of Getting organised  28
  1929.  
  1930.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1931.  
  1932.  
  1933.  
  1934.   6.0 PACKAGING
  1935.  
  1936.  
  1937.  
  1938.   6.1 AVAILABILITY
  1939.  
  1940.   The most recent version of Downsort is always downloadable and
  1941.   file-requestable from Bulletin Board "PC-Square" of the Dutch IBM employee
  1942.   PC club.  Search or request DWNSRT??.* to be independent of the version and
  1943.   compression method!
  1944.  
  1945.   FIDO-net address:  2:512/4; phone:  31-79-424107 (USR HST-DS).
  1946.  
  1947.   Downsort is distributed in area SDSMAX of the international Shareware
  1948.   Distribution System.
  1949.  
  1950.   There is a fair chance you may find a recent version on one of the other
  1951.   bulletin boards, listed in "Appendix B.  World-wide use of Downsort" on
  1952.   page 44.
  1953.  
  1954.   Downsort is distributed in 2 archives:
  1955.  
  1956.   ■  A file "DWNSRTxy.ZIP", containing all material you need to run Downsort,
  1957.      including documentation, formatted for browsing or printing (formfeed is
  1958.      the only printer-control).
  1959.  
  1960.   ■  A file "DWNSRSxy.ZIP", containing all SOURCE material.
  1961.  
  1962.   Note: 'xy' is the version indication, for example DWNSRT57.ZIP is the
  1963.   version 5.7 runtime package.
  1964.  
  1965.  
  1966.   6.2 RUN-TIME MATERIAL
  1967.  
  1968.   WHATSNEW.57         Summary of amendments to version 5.7 of Downsort.
  1969. | DOWNSORT.EXE        Execution module for OS/2 and DOS (Family Application)
  1970. | DOWN386.EXE         32-bits execution module for OS/2 2.0 or 2.1.
  1971. | DOWN386.ICO         ICON file for DOWN386.EXE.
  1972.   DOWNSORT.DOC        Documentation (this file!).
  1973.   DOWNSORT.CFG        Sample configuration file.  This file contains comment
  1974.                       lines with extensive instructions how to specify the
  1975.                       parameters in the file.
  1976.   DOWNSORT.HDR        Sample BBS-list header.  You may use this header, which
  1977.                       is only imbedded in the BBS-list, to imbed text and/or
  1978.                       MECCA-sequences.  A good candidate for the latter would
  1979.                       be [onexit], which translates to ^OFpath.  See the
  1980.                       sample Downsort.HDR file!
  1981.   DOWNSORT.TRL        Sample BBS-list trailer.
  1982.   DOWNSORT.BMP        Bitmap for the IPF-list, to be included by the IPF
  1983.                       compiler.
  1984.   DOWNSORT.INC        Sample Include-file for the reports, referenced in
  1985.                       Downsort.CFG.
  1986.   DOWNSORT.MAG        Sample list of magic names to be included in OKFile(s).
  1987.                       See BinkleyTerm documentation for details of its format
  1988.                       and contents.
  1989.  
  1990.  
  1991.                                                                 Packaging  29
  1992.  
  1993.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  1994.  
  1995.  
  1996.  
  1997.   HPFSDATE.EXE        Program to display all three timestamps of a file on an
  1998.                       HPFS volume, and optionally reset the CREATION date to
  1999.                       LASTWRITE date (helpful after moving or copying of
  2000.                       files).  Start the program without options to display
  2001.                       command syntax and help.
  2002.   PACKING.LST         The actual contents of the package (produced with
  2003.                       PKUNZIP -V), added to the ZIP-file after this was
  2004.                       created with the foregoing files of this archive.  This
  2005.                       gives at least some authentication!
  2006.  
  2007.  
  2008.  
  2009.   6.3 SOURCE MATERIAL
  2010.  
  2011.   DOWNSORT.C          Mainline.
  2012.   DOWNCOL.C           Data collection functions.
  2013.   DOWNFNT.C           Font definition and formatting functions.
  2014.   DOWNPAR.C           Processing functions for commandline and Downsort.CFG
  2015.                       parameters.
  2016.   DOWNRPT1.C          Functions for NEW-, BBS- and EMI-list.
  2017.   DOWNRPT2.C          Functions for the IPF-lists.
  2018.   DOWNRPT3.C          Functions for the SYSOP-oriented lists, like ORPhan-,
  2019.                       OK-, and DUPlicate-lists, as well as FILES.BBS files.
  2020.   DOWNRPT4.C          Functions for the ALL- and GBL-lists.
  2021.   DOWNSRV.C           Miscellaneous services functions.
  2022.   DOWNVARS.C          Constants and global variables.
  2023.   DOWNSORT.H          Header file, with external definitions of global
  2024.                       variables.
  2025.   DOWNFPRO.H          Common (global) function prototypes.
  2026.   DOWNSORT.SCR        Unformatted documentation file.  This file includes
  2027.                       formatting tags in BOOKMASTER style for printing on
  2028.                       whatever devices are supported (like IBM page
  2029.                       printers).  This format is compatible and can be
  2030.                       formatted on an IBM host system with DCF (SCRIPT) as
  2031.                       well.  The file can also processed by the IPF-compiler
  2032.                       (just ignore the warnings and error-messages!).
  2033. | DOWNSORT.DEF        LINK definition file for OS/2 (1.3 and 2.0)
  2034. | DOWN386.MAK         MAKE file for DOWN386.EXE for OS/2 2.0 or 2.1, C Set/2
  2035. |                     compiler and appropriate program development toolkit
  2036. |                     (OS/2 2.0 or 2.1)
  2037. | DOWNSORT.MAK        MAKE file for Downsort.EXE OS/2 1.3, MS C-compiler
  2038. |                     6.00a.  The program development toolkit (OS/2 1.2/1.3)
  2039. |                     is needed when using IBM C/2 1.1 compiler.
  2040.   PACKING.LST         The actual contents of the package (produced with
  2041.                       PKUNZIP -V), added to the ZIP-file after this was
  2042.                       created with the foregoing files of this archive.  This
  2043.                       gives at least some authentication!
  2044.  
  2045.  
  2046.  
  2047.  
  2048.  
  2049.  
  2050.  
  2051.  
  2052.  
  2053.  
  2054.                                                                 Packaging  30
  2055.  
  2056.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2057.  
  2058.  
  2059.  
  2060.   6.4 INSTALLATION
  2061.  
  2062.   With the following directions you should be able to setup and run Downsort
  2063.   in a very short time.
  2064.  
  2065.   1. Make a separate directory for Downsort, and make it the current default
  2066.      directory every time you run Downsort.  The separate directory is a
  2067.      recommendation, not a requirement!
  2068.  
  2069.   2. Copy the files Downsort.EXE and Downsort.CFG from the Downsort package
  2070.      into this directory.
  2071.  
  2072.   3. Modify (edit) the file Downsort.CFG to specify your environment and list
  2073.      requirements.  The sample file contains comments to help you with this
  2074.      process.  Most specifications are obvious.  AreaDat is the most
  2075.      important parameter: Downsort won't do anything useful if it cannot find
  2076.      this MAXIMUS file.  See "Appendix D.  Sample Configuration File" on page
  2077.      48 for a printed sample.
  2078.  
  2079.   4. You may give Downsort a first shot by just using its name on the
  2080.      commandline, with the parameter -H.  This will show a brief HELP-screen
  2081.      with the possible commandline parameter specifications.
  2082.  
  2083.   5. All reports will be created in the Downsort directory (unless you
  2084.      specified 'fpath' for the FILES.BBS output).  Browse the lists to see if
  2085.      you like the contents and titles, and modify the CFG-file to your
  2086.      convenience.
  2087.  
  2088.  
  2089.  
  2090.   6.5 DEPENDENCIES AND RESTRICTIONS
  2091.  
  2092.   ■  Applies to MAXIMUS CBCS 2.01
  2093.  
  2094.   ■  Requires OS/2 or DOS 3.0+.
  2095.  
  2096.   ■  To convert the IPF-list into VIEW-able format, the IPF-Compiler of the
  2097.      OS/2 Program Development Toolkit is required (for the IP2-list the
  2098.      corresponding OS/2 2.0 version of this compiler)
  2099.  
  2100.   ■  The input FILES.BBS files are assumed to contain only filename.ext (the
  2101.      regular 8.3 format, no support for OS/2 1.2+ HPFS format), the remainder
  2102.      of the line is considered as file description.  The filename should be
  2103.      left-aligned (start in position 1).
  2104.  
  2105.      If a privilege modifier (^Px) is encountered in FILES.BBS then 'x' will
  2106.      become the privilege of all subsequent files (it assumes ^Px on a
  2107.      SEPARATE line, the REST OF THE LINE IS IGNORED!).  Heading, comments and
  2108.      blank lines in FILES.BBS are ignored, unless /K is specified on the
  2109.      FilFileList line of Downsort.Cfg.  In that case comments following line
  2110.      8 (the standard header created by Downsort) are preserved.  The modified
  2111.      privilege might be higher (generally the case) or lower than the
  2112.      area-privilege.
  2113.  
  2114.  
  2115.  
  2116.  
  2117.                                                                 Packaging  31
  2118.  
  2119.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2120.  
  2121.  
  2122.  
  2123.   6.6 STORAGE AND PERFORMANCE
  2124.  
  2125.   As a rough estimate of the memory requirements of Downsort, use sum of the
  2126.   following elements:
  2127.  
  2128.   ■  Program: about 80KB
  2129.  
  2130.   ■  Each area: 300 Bytes
  2131.  
  2132.   ■  Each file: 48 Bytes for each download file (excluding file descriptions
  2133.      and excluding orphans if no orphan-list requested)
  2134.  
  2135.   ■  The sum of the file description texts (average 80 bytes/file?)
  2136.  
  2137.   ■  The sum of the comments in FILES.BBS if -K option specified
  2138.  
  2139.   The maximum number of area's for reporting is 217.  Your system may have
  2140.   more, but Downsort can currently not work properly when more than 217
  2141.   area's will have to be scanned for files.
  2142.  
  2143.   There is a limit on the number of files that can be processed by Downsort:
  2144.   about 16350.  I suppose you'll reach other limits first, for example
  2145.   available memory (under DOS).  But might you reach this limit, then you
  2146.   could do one or more of the following:
  2147.  
  2148.   ■  Use AreaEXclude or AreaINclude to make a selection of groups (for
  2149.      example make separate OS/2 and a DOS file-lists).  Downsort will not
  2150.      collect information of 'excluded' areas.
  2151.   ■  If you have many orphans: get rid of them or do not generate an orphan
  2152.      report.  Downsort releases orphan-memory during the data collection
  2153.      phase as soon as it knows that a file is an orphan.
  2154.   ■  If you have many comment-lines in your FILES.BBS: do not specify /K for
  2155.      ALL- and IPF-lists AND do not activate the FILFilePath parameter in
  2156.      Downsort.Cfg.  Downsort will skip comments in FILES.BBS when it does not
  2157.      need them for reporting.
  2158.  
  2159.   Downsort has been built with a 'guess' about needed stack space.  The
  2160.   author would appreciate to receive a report for a better estimate.
  2161.  
  2162.   Processor performance was an issue for large file-area's before version 4.5
  2163.   of Downsort in the data-collection process.  That has been partly rewritten
  2164.   in version 4.5 and significantly improved.  Fastest execution will always
  2165.   be obtained when the input FILES.BBS is already sorted on filename.
  2166.  
  2167.  
  2168.   6.7 PROBLEMS
  2169.  
  2170.   Although I try to prevent the cause of them, there are some unresolved
  2171.   problems in the current version of Downsort:
  2172.  
  2173.   ■  One user reported unidentified characters in titles.
  2174.  
  2175.  
  2176.  
  2177.  
  2178.  
  2179.  
  2180.                                                                 Packaging  32
  2181.  
  2182.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2183.  
  2184.  
  2185.  
  2186.   6.8 WISHLIST
  2187.  
  2188.   Downsort is not finished!  There are a number of wishes and requirements of
  2189.   users and myself to include in future releases.  I list them below not in
  2190.   any particular order, but some seem to be more important than others, that
  2191.   differs from SYSOP to SYSOP.  And some are more easy to implement than
  2192.   others, which depends mainly on the author!  Some wishes don't even make it
  2193.   to be listed below and are implemented immediately!
  2194.  
  2195.   ■  Follow the MAXIMUS development (changing AREA.DAT and other structures),
  2196.      and support several versions simultaneously.
  2197.   ■  User-configurable options for:
  2198.      ∙  week and month indicators
  2199.      ∙  indicator for continuation lines in wrapped descriptions
  2200.      ∙  Avatar codes in FILES.BBS headers
  2201.      ∙  [selectable] MECCA control in FILES.BBS
  2202.      ∙  Private headers in FILES.BBS in stead of the standard headers
  2203.      ∙  Right margin (line length) and left margin for continuation lines of
  2204.         long descriptions, and an optional 'indent' for a download counter.
  2205.   ■  Logging to file in stead of stdout to obtain a history file of Downsort
  2206.      usage.
  2207.   ■  File-selection with MAXIMUS CBCS key/lock parameters in addition to or
  2208.      in stead of area privilege levels.
  2209.   ■  Support for use of 'barricaded' areas and key/lock.
  2210.   ■  List with the format of IPF-list but the contents of NEW-list.
  2211.   ■  Automatic removal of 'bad' files (like .BAK-files, obsolete files, files
  2212.      that are not in FILES.BBS), maybe move them to a special BAD_FILE
  2213.      directory.  Entries in FILES.BBS should be removed accordingly.
  2214.  
  2215.   Remember: Was there ever a time that all your wishes were fulfilled?  That
  2216.   was the most boring time of your life, wasn't it?
  2217.  
  2218.  
  2219.  
  2220.  
  2221.  
  2222.  
  2223.  
  2224.  
  2225.  
  2226.  
  2227.  
  2228.  
  2229.  
  2230.  
  2231.  
  2232.  
  2233.  
  2234.  
  2235.  
  2236.  
  2237.  
  2238.  
  2239.  
  2240.  
  2241.  
  2242.  
  2243.                                                                 Packaging  33
  2244.  
  2245.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2246.  
  2247.  
  2248.  
  2249.   7.0 INTERNALS
  2250.  
  2251.  
  2252.  
  2253.   7.1 DEVELOPMENT ENVIRONMENT
  2254.  
  2255. | The family-version of Downsort (for OS/2 1.3 and DOS) is compiled with
  2256. | MicroSoft C compiler version 6.00a, with the IBM OS/2 Programming Tools and
  2257. | Information (generally called the OS/2 toolkit) under IBM OS/2 Extended
  2258. | Edition 1.3 as COMPACT memory model.  The generated code is at 80286 level
  2259. | (Compiler option /G2), since I believe that only very few Bulletin Boards
  2260. | do use an XT these days.
  2261.  
  2262. | The 32-bit OS/2 2.0+ only version of Downsort is compiled with IBM C Set/2
  2263. | and the 2.0 Toolkit.
  2264.  
  2265. | There is only a single set of source files.  A compiler variable takes care
  2266. | of the selection between 1.3 and 2.0 calls where necessary.
  2267.  
  2268. | Downsort has been tested for MAXIMUS CBCS 2.0, with the following Operating
  2269. | Systems:
  2270.  
  2271. | ■  IBM OS/2 versions 1.3, 2.0 and 2.1
  2272. | ■  IBM PC/DOS version 5.0.
  2273.  
  2274.  
  2275.  
  2276.   7.2 PROGRAM ORGANISATION
  2277.  
  2278.   The program is organised as follows:
  2279.  
  2280.   ■  Initialisation:
  2281.      ∙  Read configuration file.
  2282.      ∙  Process commandline parameters.
  2283.  
  2284.      Commandline parameters may override configuration file parameters.
  2285.  
  2286.   ■  Read AREA.DAT file to collect download pathnames (only of those area's
  2287.      that will participate this time).
  2288.  
  2289.   ■  For each file-area with a privilege not exceeding any list-request:
  2290.  
  2291.      ∙  Read subdirectory (with find-file-first/next function).  Take only
  2292.         Normal files: ignore directory entries, Hidden and System files and
  2293.         volume labels.  Also ignore files with the following specifications:
  2294.         FILES.*, *.BAK, DIR.?BS and SYSTEM*.?BS.
  2295.  
  2296.      ∙  For all regular file-entries found in subdirectory:
  2297.         -  Get filename.ext, attribute, date, time, size.
  2298.         -  Get file-description from FILES.BBS file.  The path to the
  2299.            FILES.BBS file is (1) obtained from the "ListFile" specification
  2300.            in MAXIMUS AREA.DAT file, or (2) if not specified from the
  2301. |          "DownLoad" specification (among the download files).
  2302. |       -  Add files with explicit path specifications.
  2303.         -  Get file privilege 1) from area, 2) from FILES.BBS file if higher.
  2304.  
  2305.  
  2306.                                                                 Internals  34
  2307.  
  2308.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2309.  
  2310.  
  2311.  
  2312.         -  When no orphan reporting is required, then drop orphan entries
  2313.            area-by-area.
  2314.  
  2315.   ■  For the ORP-list:
  2316.  
  2317.      If any orphan found, and the orphan-report is requested, create the
  2318.      orphan report, with the file-entries sorted on (1) area and (2)
  2319.      filename.
  2320.  
  2321.   ■  For the BBS-list:
  2322.      ∙  Sort the files primarily on descending file-timestamp (and secundary
  2323.         on file-name and area-code).
  2324.      ∙  Resort the first files on filename if requested.
  2325.      ∙  Create output file for sorted list of filenames, -descriptions, etc.
  2326.         The file is placed in the current subdirectory (which generally will
  2327.         be the MAXIMUS directory) with the name Downsort.BBS.
  2328.      ∙  Copy a headerfile (for a customised MAXIMUS bulletin).
  2329.      ∙  Put files in formatted outputfile (filename, area#, date, size,
  2330.         description), but only if description is found in FILES.BBS.  Skip
  2331.         files with privilege higher than commandline (or default) parameter.
  2332.         Precede each line with a privilege-control sequence (^PLx string) so
  2333.         that MAXIMUS users below the specified max-priv-level do effectively
  2334.         see only the files they can download.
  2335.      ∙  Include a trailerfile in the outputfile (for a custimised Bulletin).
  2336.      ∙  Report non-listed files on standard output device (which might be
  2337.         re-directed to printer or disk-file).
  2338.  
  2339.   ■  If requested, put the above file collection in Downsort.N~p with similar
  2340.      contents and layout as Downsort.BBS, but without BBS-control sequences,
  2341.      and without including a header and trailer file.  Produce a list for the
  2342.      default privilege (HIDDEN), or one for each specified privilege.
  2343.  
  2344.   ■  If requested, re-sort files on area and then filename or date, and
  2345.      create Downsort.A~p, containing all files (respecting the privilege
  2346.      restrictions!).  Area's with zero files within the applicable privilege
  2347.      limit will not be listed at all (will seem non-existing!).  Produce a
  2348.      list for the default privilege (SYSOP), or one for each specified
  2349.      privilege.
  2350.  
  2351.      At the end of the list, an area summary report is generated.
  2352.  
  2353.   ■  If requested, re-sort files on filename or date only, and create
  2354.      Downsort.GBL.
  2355.  
  2356.   ■  If requested, re-sort files on area, privilege and filename, and create
  2357.      for each area a FILES.BBS-type of file.
  2358.  
  2359.   ■  If requested generate a list of probably DUPlicate files.
  2360.  
  2361.   ■  If requested generate a list of download-paths: the OK-file (not: it
  2362.      will contain only the paths that participated in this run.
  2363.  
  2364.   NOTE: the program firstly reads a directory for existing files (not Hidden-
  2365.   or System-files, and not Subdirectory or Volumelabel), and then reads
  2366.   FILES.BBS to assign a description to each file.  This means:
  2367.  
  2368.  
  2369.                                                                 Internals  35
  2370.  
  2371.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2372.  
  2373.  
  2374.  
  2375.   ■  If more than 1 matching file-specification in FILES.BBS of the involved
  2376.      area is found (note that wild-card specifications in FILES.BBS are
  2377.      supported!), than the first matching description from FILES.BBS will
  2378.      appear in the lists (new in version 4.5, was 'last' in previous versions
  2379.      of Downsort).
  2380.   ■  Files for which no description is found in FILES.BBS will get "---no
  2381.      description available---" (or the replacement string you specified in
  2382.      Downsort.CFG) in the user reports.
  2383.   ■  Files for which no matching filename in FILES.BBS is found will be
  2384.      listed in the Orphan report (Downsort.ORP).
  2385.  
  2386.      Files for which there is an entry in FILES.BBS, but a corresponding file
  2387.      is not found in the directory will be reported as 'offline'.
  2388.  
  2389.      In special cases this might become a very large list.  For example if
  2390.      you collect files in a single directory for different area's, all the
  2391.      files of 'the other' areas are reported as orphan.  This will happen for
  2392.      every area, so each file might even be reported many times as orphan!
  2393.      Since the Orphan-list is now optional (from version 5.0 on), this list
  2394.      can be suppressed.
  2395.  
  2396.      Filenames of Orphans appear only in the other reports when the FileList
  2397.      request explicitly specifies the Hidden privilege.
  2398.  
  2399.  
  2400.  
  2401.   7.3 MAIN DATA ORGANISATION
  2402.  
  2403.   Data structure for access to file information via:
  2404.  
  2405.   1. array of file-pointers (for file-sort!)
  2406.   2. pointerchain in file-info structures
  2407.   3. file structure contains pointer to file-description
  2408.   4. file-structure contains pointer to area-information
  2409.   5. Array of area-information
  2410.  
  2411.   The structures are shown in the following figure.
  2412.  
  2413.  
  2414.  
  2415.  
  2416.  
  2417.  
  2418.  
  2419.  
  2420.  
  2421.  
  2422.  
  2423.  
  2424.  
  2425.  
  2426.  
  2427.  
  2428.  
  2429.  
  2430.  
  2431.  
  2432.                                                                 Internals  36
  2433.  
  2434.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2435.  
  2436.  
  2437.  
  2438.  
  2439.   ╔══════╗
  2440.   ║  dm  ║
  2441.   ╚══════╝
  2442.       │         Array of pointers to structures with file info
  2443.       │      ╔═══════════╦════════════╦═════════════ . . . ══════╗
  2444.   (1) └─────>║ *file[0]  ║  *file[1]  ║ *file[2]                 ║
  2445.              ╚═══════════╩════════════╩═════════════ . . . ══════╝
  2446.                    │           │            │
  2447.   (2)              v           v            v
  2448.   ╔══════╗     ╔══════╗     ╔══════╗     ╔══════╗
  2449.   ║  ca  ║ ──> ║ next ║ ──> ║ next ║ ──> ║ next ║ ──> . . .
  2450.   ╚══════╝     ╠══════╣     ╠══════╣     ╠══════╣
  2451.    (first-     ║ file-║     ║ file-║     ║ file-║
  2452.    element)    ║ info ║     ║ info ║     ║ info ║    . . .
  2453.                ║ [0]  ║     ║ [1]  ║     ║ [2]  ║
  2454.                ╚══════╝     ╚══════╝     ╚══════╝
  2455.                    │ │         │  │wildcards│ │
  2456.                    │ └──┐      │  └──┐      │ │
  2457.                    │    │      │ ┌──────────┘ │
  2458.   (3)              v    │      v v   │ ┌──────┘
  2459.                ╔══════╗ │   ╔══════╗ │ │
  2460.                ║file- ║ │   ║file- ║ │ │(files of
  2461.                ║descr ║ │   ║descr ║ │ │ same area)   . . .
  2462.                ╚══════╝ │   ╚══════╝ │ │
  2463.                         │            │ │
  2464.   (4)                   v            v v
  2465.                 ╔════════════╦═════════════╦════════ . . . ══════╗
  2466.   (5) ┌────────>║  area[0]   ║   area[1]   ║                     ║
  2467.       │         ╚════════════╩═════════════╩════════ . . . ══════╝
  2468.       │              array of structures of download info
  2469.   ╔══════╗
  2470.   ║ area ║
  2471.   ╚══════╝
  2472.  
  2473.   Schematic overview of Downsort's in-storage database.
  2474.  
  2475.   Note: The area-array cannot be sorted itself: this would invalidate the
  2476.   pointers in the file-information records!
  2477.  
  2478.   The block character image is basically a 10x7 matrix (10 vertical and 7
  2479.   horizontal 'pixels').  The pixel-array takes two rows at a time, so that
  2480.   each character can be represented with 5 rows of 7 horizontal
  2481.   'double-pixels'.  Each pixel is displayed as a solid block.
  2482.  
  2483.  
  2484.  
  2485.  
  2486.  
  2487.  
  2488.  
  2489.  
  2490.  
  2491.  
  2492.  
  2493.  
  2494.  
  2495.                                                                 Internals  37
  2496.  
  2497.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2498.  
  2499.  
  2500.  
  2501.            1 2 3 4 5 6 7
  2502.           ╔═╦═╦═╦═╦═╦═╦═╗
  2503.           ║-║-║-║-║-║-║-║   line 1    (lower + upper)
  2504.           ╠═╬═╬═╬═╬═╬═╬═╣
  2505.           ║-║-║-║-║-║-║-║        2    (lower + upper)
  2506.           ╠═╬═╬═╬═╬═╬═╬═╣
  2507.           ║-║-║-║-║-║-║-║        3    (lower + upper)
  2508.           ╠═╬═╬═╬═╬═╬═╬═╣
  2509.           ║-║-║-║-║-║-║-║        4    (lower + upper)
  2510.           ╠═╬═╬═╬═╬═╬═╬═╣
  2511.           ║-║-║-║-║-║-║-║        5    (lower + upper)
  2512.           ╚═╩═╩═╩═╩═╩═╩═╝
  2513.  
  2514.   Each line is represented by a structure of seven 3-bit fields Each 3-bit
  2515.   field represents a basic element:
  2516.  
  2517.    value    char       description
  2518.      0                 (blank)
  2519.      1     &BOXBOT.           lower half
  2520.      2       &BOXTOP.         upper half
  2521.      3         &BOX.       lower+upper halves
  2522.      4       &box34.         gray pattern
  2523.      5     &BOXLEFT.           left part of upper and lower half
  2524.      6       &BOXRIGHT.         right part of upper and lower half
  2525.      7         &box14.       gray pattern
  2526.      8      &box12.          gray pattern for not-supported characters
  2527.  
  2528.   The pitch is variable ('proportional font': a variable number of horizontal
  2529.   pixels).  Three fonts are provided with different character-image and size:
  2530.  
  2531.   1. 6x5 (three lines of max 5 characters)
  2532.   2. 10x7 (five lines of max 7 characters)
  2533.   3. 8x7 (four lines of max 7 characters)
  2534.   4. 10x7 (reverse video image of the 8x7 font)
  2535.  
  2536.   Not all ASCII characters are represented in the font tables!
  2537.  
  2538.  
  2539.  
  2540.  
  2541.  
  2542.  
  2543.  
  2544.  
  2545.  
  2546.  
  2547.  
  2548.  
  2549.  
  2550.  
  2551.  
  2552.  
  2553.  
  2554.  
  2555.  
  2556.  
  2557.  
  2558.                                                                 Internals  38
  2559.  
  2560.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2561.  
  2562.  
  2563.  
  2564.   APPENDIX A.  HISTORY OF CHANGES
  2565.  
  2566.   The paragraphs below show a brief history of changes in Downsort (most
  2567.   recent revisions on top of list!).
  2568.  
  2569.   Downsort for MAXIMUS CBCS was developed from an OPUS equivalent (by the
  2570.   same author).  Its pre-MAXIMUS history is not really important here and
  2571.   therefore has been omitted.  However the name Downsort has been maintained,
  2572.   so to prevent confusion, the version number is inherited (the last version
  2573.   for OPUS was 3.1).
  2574.  
  2575.  
  2576.   8.1 VERSION 5.7
  2577.  
  2578.   ■  A 32-bit version (OS/2 2.0+ only) added to runtime package, no
  2579.      functional differences with the family version.
  2580.   ■  ICON file DOWN386.ICO added for the 32-bit version of Downsort.
  2581.   ■  Long areanames (8 characters) are now supported in all reports.
  2582.   ■  Changed naming convention of 'FILES.BBS' output files when area's with
  2583.      'long' (more than 3 character) names are used.
  2584.   ■  The "FILES.BBS"-type of output (selected with FILFileList in
  2585.      Downsort.Cfg) now produces a slightly different header.  Downsort
  2586.      recognises its own header and an included-file without
  2587.      'multiplication'-effects.
  2588.   ■  Explicit path specifications of files in FILES.BBS are now supported.
  2589.      As a consequence:
  2590.      ∙  The long format of OK-FileList will contain this explicit path in
  2591.         stead of the filearea path.
  2592.      ∙  It seems more appropriate to list the pathspec in the DUP-FileList
  2593.         rather than the file description.
  2594.      Generic filenames (wildcard specifications) are NOT supported
  2595.      (yet)!
  2596.   ■  File size and date can be included in FILES.BBS output with the '-L'
  2597.      option on the FILFileList line in Downsort.Cfg.
  2598.   ■  A new keyword 'NonDupEXT' allows suppression of reporting a file as
  2599.      'duplicate' when it is a member of a pair of files with specified
  2600.      extensions.  Example xyz.SDN and xyz.SDA can be excluded from
  2601.      DupFileList.
  2602.   ■  Doc-file now also included as provisional .INF file for OS/2 VIEW.
  2603.   ■  Improved Avatar stripping.
  2604.   ■  Bug fix for long 'new'-filelist periods (>32000 days).
  2605.   ■  Separation between progress signals (stdout) and error messages (stderr)
  2606.      and other 'internal' changes:
  2607.   ■  Preparations made to remove most commandline parameters.  It has been
  2608.      redundant for a long time.  Every Downsort specification on the
  2609.      commandline can also be made via Downsort.Cfg.  Exception: Specification
  2610.      of a configuration file will remain possible!  Good arguments may change
  2611.      this intention, so please object if I am overlooking something.
  2612.  
  2613.  
  2614.  
  2615.  
  2616.  
  2617.  
  2618.  
  2619.  
  2620.  
  2621.                                           Appendix A.  History of changes  39
  2622.  
  2623.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2624.  
  2625.  
  2626.  
  2627.   8.2 VERSION 5.6
  2628.  
  2629.   ■  In stead of the regular OKFile format (path\*.*), there is now also an
  2630.      option (/L) to produce a LONG format of the OKFile, containing
  2631.      explicitly all files within privilege with complete file-specification
  2632.      (path\filename.ext).  Useful for file-requests at systems with large
  2633.      directories, and especially with CDROM's.  With this option in effect,
  2634.      the *.* entries will not be generated, so file requests are only honored
  2635.      with EXACT filenames: wildcard specifications do not work anymore!
  2636.   ■  Improved display of long areanames (>3 char) in ALL- and IPF-lists.
  2637.   ■  Avatar codes may be stripped from comment lines in reports.
  2638.   ■  Missing include-files are now only reported when running Downsort in
  2639.      -V(erbose) mode.
  2640.   ■  Some bug fixes (some of them causing Trap 000D under OS/2):
  2641.      ∙  If 'downsort.cfg' not found, return code 2 is reported, and
  2642.         downsort.cfg now closed at end of file.
  2643.      ∙  Output of FILES.BBS could be erraneous when also IP2-list selected.
  2644.      ∙  Limit of 217 active area's now relieved (this limit was not
  2645.         documented!).
  2646.      ∙  Improved handling of parameters of FILFilePath-line in the sample
  2647.         Downsort.Cfg file.  Also the explanatory comments are revised.
  2648.   ■  '-'-character now precedes the formfeed character in newly created
  2649.      FILES.BBS files (version 5.6h+).
  2650.   ■  Downsort source is now compilable with IBM C-Set/2 compiler and IBM OS/2
  2651.      2.0 toolkit to obtain a real 32-bit version for OS/2 2.0+.
  2652.  
  2653.  
  2654.  
  2655.   8.3 VERSION 5.5
  2656.  
  2657.   ■  Finally(!) a sort capability for area-sequence.  Areas can now be
  2658.      presented in order of AREA.DAT ('K'eep original sequence), sorted on
  2659.      areaname ('A'lphabetically), sorted in alphanumeric ('G'roup) sequence
  2660.      or in order of areaINclude ('I').  The group-sequence is useful with a
  2661.      popular naming convention whereby the areaname starts with one or more
  2662.      letters followed by one or more digits.  Names starting with a digit
  2663.      will be sorted as if it were all numeric, and will be sorted
  2664.      accordingly.
  2665.   ■  NEW-, BBS-list and EMI-list (see below) can now also be limited in
  2666.      length by file-age (period specification in number of Days, Weeks or
  2667.      Months).
  2668.   ■  A new list-type introduced: EMI-list (new file EMIsions).  I is a simple
  2669.      list, comparable to NEW-list.  It has a more compact format, and gives
  2670.      also file-time and the file-size (in exact bytes).  It is especially
  2671.      useful to generate messages with file arrivals over the last period (in
  2672.      combination with a period specification).
  2673.   ■  Readability improvements in IP2-list.
  2674.   ■  Documentation extended with sample output for new users of Downsort.
  2675.   ■  Some bug-fixes:
  2676.      ∙  Compares of path- and area-names now case INdependent
  2677.      ∙  Memory allocation error during collection of comments in FILES.BBS
  2678.      ∙  Index out-of-range in report preparation phase
  2679.      ∙  Processing of /K-option for areas with FILES.BBS but otherwise empty.
  2680.  
  2681.  
  2682.  
  2683.  
  2684.                                           Appendix A.  History of changes  40
  2685.  
  2686.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2687.  
  2688.  
  2689.  
  2690.   8.4 VERSION 5.4
  2691.  
  2692.   ■  Inline comments in FILES.BBS will be reproduced now!  When AND ONLY WHEN
  2693.      the /K option is specified for All- or IPF-list, or for FILFilePath, the
  2694.      original existing comments in FILES.BBS are copied into All- or IPF-list
  2695.      or newly created FILES.BBS files.  So note: /K means now: Keep sequence
  2696.      of FILES.BBS and Keep comments in FILES.BBS and other lists that support
  2697.      the /K option (ALL-, IPF and IP2-list).
  2698.  
  2699.      Note: /K is now the default sort parameter for FILFilePath, so that you
  2700.      do not loose your comments accidently.
  2701.   ■  Downsort's interpretation of the meaning of 'orphan' changed a little:
  2702.      an 'orphan' is from now on defined as a file for which there is no
  2703.      description in any FILES.BBS of all areas pointing to the same
  2704.      directory.  This may reduce improper(?) orphan-reporting by previous
  2705.      versions of Downsort considerably when you have physically a single
  2706.      large directory of which the files are grouped logically in different
  2707.      areas with separate FILES.BBS files.
  2708.   ■  Duplicate download directories in OK-files will be suppressed.
  2709.   ■  Area-summaries in ALL- and IPF-lists are again sorted alphabetically on
  2710.      area-name.
  2711.   ■  A check during the data collection phase on maximum supported file
  2712.      entries (16350) has been added to prevent problems when exceeding this
  2713.      limit.
  2714.   ■  Orphan entries in FILES.BBS are now preceeded with '^PS' in stead of the
  2715.      unsupported '^PH' (bug fix).
  2716.   ■  Some specific adaptations for version 2.0:
  2717.      ∙  All files conforming to filespec 'FILES.*' will not be reported
  2718.         anymore.
  2719.      ∙  Area code will be handled as 9 character string: area-name!  But in
  2720.         some reports it will be truncated to the first 3 or 4 characters.
  2721.      ∙  AreaINclude and AreaEXclude are used as 'prefix'.  Area-name
  2722.         specifications will be treated as group-names: you can include or
  2723.         exclude groups of areas starting with the same characters.
  2724.      ∙  The /b, /t, /bt or /tb flag in FILES.BBS will not appear in the
  2725.         lists, but only when it appears immediately after the filename.  It
  2726.         is not stripped from FILES.BBS.
  2727.   ■  As experiment a new list has been added: IP2FileList.  It is a copy if
  2728.      IPF-list, but uses some new formatting features offered by the
  2729.      IPF-compiler of the OS/2 2.0-beta toolkit (i.c.
  2730.  
  2731.      The result is a faster generation, but above al a faster compilation
  2732.      and a better VIEW.  VIEWing under OS/2 1.2 or 1.3 is still possible!
  2733.  
  2734.  
  2735.  
  2736.   8.5 VERSION 5.3
  2737.  
  2738.   ■  New report added: DUP-list, a simple list, for SYSOP-use only, that
  2739.      shows (possibly) duplicate fileNAMES over the area's (the
  2740.      file-extension is not considered in the comparison).
  2741.   ■  Another new report: OKFile in BinkleyTerm style.  A list of download
  2742.      paths within privilege, with option to include magic names.
  2743.   ■  IpfFileList line in Downsort.Cfg now also allows specification of the
  2744.      IPF pagesize (maximum number of file-entries per VIEW 'page' or
  2745.  
  2746.  
  2747.                                           Appendix A.  History of changes  41
  2748.  
  2749.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2750.  
  2751.  
  2752.  
  2753.      'part').
  2754.   ■  Progress signals streamlined, /Q is really silent now!
  2755.   ■  Fixed bug which caused Trap 000D under OS/2 (protection violation)
  2756.      under some rare conditions.  The restriction that first area may not be
  2757.      empty or not contain only orphans has been removed with this change.
  2758.   ■  Support for MAXIMUS CBCS 1.00 removed: only version 1.02 is supported
  2759.      (and most likely 2.00 as well).
  2760.   ■  Downsort's change-history before version 5.0 removed from
  2761.      documentation.
  2762.   ■  Use of MicroSoft C Compiler 6.00a: more free memory for DOS users (also
  2763.      because of slightly improved program structuring).
  2764.  
  2765.  
  2766.  
  2767.   8.6 VERSION 5.2
  2768.  
  2769.   ■  Area selection is now possible within Downsort.  Two new keywords are
  2770.      provided in Downsort.CFG: AreaINclude to make reports for selected
  2771.      download area's, AreaEXclude to omit area's from the reports.  These
  2772.      keywords have only effect within the collection that would otherwise
  2773.      have been reported completely (restricted by AREA.DAT and report
  2774.      privilege).
  2775.   ■  FILES.BBS has now a peer relation with the directory in stead of being
  2776.      subordinate, in Downsort terms of course.  Filenames and their
  2777.      description in FILES.BBS for which there is no corresponding file in
  2778.      the download directory, are now NOT ignored anymore.  In stead the file
  2779.      is reported as 'offline' (on the columns for file-date and -size).  You
  2780.      may replace the word 'offline' with an alternative text.
  2781.   ■  Bug repaired that caused some files to be treated as orphan under
  2782.      certain rare circumstances.  And a correction of an error in
  2783.      'end-of-line' test/search on several places.
  2784.   ■  As already 'promised' in 5.1, the Area-summary in ALL-list is now in
  2785.      order of AREA.DAT.
  2786.   ■  Reorganised the documentation to obtain a more logical sequence of
  2787.      subjects.  Due to the growing number of options of Downsort, it became
  2788.      more and more difficult to see the trees through the wood.  I added a
  2789.      number of paragraphs, especially for new users.  It can be useful for
  2790.      YOU too!
  2791.  
  2792.  
  2793.  
  2794.   8.7 VERSION 5.1
  2795.  
  2796.   ■  Since the ORPhan report is optional (changed with version 5.0), orphan
  2797.      entries could and now will be removed from internal storage during the
  2798.      information collection phase of Downsort, but only when no orphan-list
  2799.      is requested!  This is especially useful for the situation where a
  2800.      single large directory contains the files of several area's, and
  2801.      whereby the file descriptions are contained in different FILES.BBS
  2802.      files.  Normally this will result in reporting lots of duplicate
  2803.      orphans (according to the definition of 'orphan' in Downsort!).  With
  2804.      this change memory utilisation is lower and sorting faster.
  2805.   ■  Another change of this kind: area's with a privilege exceeding any
  2806.      reporting privilege are not scanned anymore.  Apart from lower memory
  2807.      utilisation, this might be useful for CDROM and slow disk(ette)
  2808.  
  2809.  
  2810.                                           Appendix A.  History of changes  42
  2811.  
  2812.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2813.  
  2814.  
  2815.  
  2816.      systems.
  2817.   ■  The maximum number of Top-, Sub- and Bottom-Title lines has been
  2818.      extended to 20.
  2819.   ■  In addition all lists may now include a 'logo'-file with a new -I
  2820.      parameter on the individual report request specification (see sample
  2821.      Downsort.CFG).  The file will be copied into the list without any
  2822.      editing or translation.  It will be positioned directly behind the
  2823.      block-title and before the subtitle (if any).  For example: you may
  2824.      include your BBS-logo or a picture of your system configuration, or
  2825.      anything else you want to tell the file-requestors of FILES, ALLFILES
  2826.      and/or NEWFILES.  The IPF-list may also include IPF tags, with artwork,
  2827.      etc.  It may even include other files itself!  For FILES.BBS the
  2828.      contents of this Include-file will immediately follow the 'standard'
  2829.      header.
  2830.   ■  All block-fonts have now a new special character <`> (reversed quote),
  2831.      which will be 'printed' as blank (space) with halfthe width of a normal
  2832.      character.  This is useful for fine-alignment (e.g. manually centering)
  2833.      the BLOCK-title.
  2834.   ■  The chapter on 'titles and headers' has been rewritten to clarify the
  2835.      use of all title-options, please read it!.
  2836.   ■  In the SUMMARY of ALL- and IPF-lists the areas themselves are not
  2837.      sorted anymore, but presented in sequence of AREAS.CTL specification.
  2838.      This is based on the assumption that the file area's are in some kind
  2839.      of 'natural' order in AREAS.CTL (or maybe it is time to do that now!).
  2840.   ■  Descriptions in FILES.BBS are now (again) aligned on column 14 of the
  2841.      FILES.bbs file records.
  2842.   ■  IPF-list again a little more user-friendly (linking of area's).
  2843.   ■  A number of improvements have been applied to the executiontime
  2844.      messages (when running in VERBOSE mode).
  2845.  
  2846.  
  2847.  
  2848.   8.8 VERSION 5.0
  2849.  
  2850.   ■  Improved IPF-formatting: more colorful, builtin word-wrapping of VIEW
  2851.      used for file descriptions (better VIEWable under OS/2 1.3!).  It
  2852.      should now also compile without errors/warnings.  Compiling (with IPFC)
  2853.      takes significantly longer however!
  2854.   ■  The IPF-list of large filearea's (>200 files) split into parts of 200
  2855.      files to prevent files being left unlisted.
  2856.   ■  Top-level title in FileLists shows file-count and byte-count as
  2857.      available within the privilege of the list.  Thus it indicates what is
  2858.      really AVAILable to the user!  Area-count omitted in lists which are
  2859.      not area-oriented.
  2860.   ■  ORPHAN report made OPTIONAL (must be specified to get it!).
  2861.  
  2862.  
  2863.  
  2864.  
  2865.  
  2866.  
  2867.  
  2868.  
  2869.  
  2870.  
  2871.  
  2872.  
  2873.                                           Appendix A.  History of changes  43
  2874.  
  2875.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2876.  
  2877.  
  2878.  
  2879.   APPENDIX B.  WORLD-WIDE USE OF DOWNSORT
  2880.  
  2881.   PC-Square may be considered as the home-base of Downsort.  The most recent
  2882.   version is always available there (file-requests honoured between 07:00
  2883.   and 24:00 local time).
  2884.  
  2885.   PC-Square               Marcel Stikkelman     Zoetermeer, Netherlands
  2886.   2:512/4                                       31-79-424107
  2887.  
  2888.   The following SYSOPs have reported using Downsort on their respective board.
  2889.  
  2890.   OS/2-MANiA              Emmanuel Sandorfi     Paris, France
  2891.   2:320/5                                       33-1-64090640
  2892.  
  2893.   OS/2 TASK BBS           Rene Carlsen          Skagen, Denmark
  2894.   2:231/910                                     45-98451070
  2895.  
  2896.   Grizzilus Maximus       Collin Adams          Preston, UK
  2897.   2:250/121                                     44-772-828975
  2898.  
  2899.   Paradigmus Maximus      John Taylor           London, UK
  2900.   2:253/68                                      44-81-566-5393
  2901.  
  2902.   Runnin' with the Devil  Roberto Sonzogni      Treviglio BG, Italy
  2903.   2:331/205                                     39-363-302798
  2904.  
  2905.   Fernwood                Emitt Dove            Branford CT, USA
  2906.   1:141/209                                     1-203-483-0348
  2907.  
  2908.   The Planet Earth        Joel Lambert          Bridgeport CT, USA
  2909.   1:141/455                                     1-203-335-7742
  2910.  
  2911.   Bell's Theorem          Jeremy Buhler         Houston TX, USA
  2912.   1:106/7674                                    1-713-777-0633
  2913.  
  2914.   OS/2 Shareware          Pete Norloff          Fairfax VA, USA
  2915.   1:109/347                                     1-703-385-4325
  2916.  
  2917.   Singing Bear            John Tarbox           Wilmington DE, USA
  2918.   1:150/130                                     1-302-984-2238
  2919.  
  2920.   La Jungle BBS           Stephane Seguin       Quebec, Canada
  2921.   1:163/116                                     1-819-595-4917
  2922.  
  2923.   3M Australia            Graham Stair          Sydney, NSW Australia
  2924.   3:711/409                                     61-2-498-9184
  2925.  
  2926.   I have received reports from others.  Too many for this list, which is
  2927.   just meant to point to a system in your neighbourhood(?).  You may either
  2928.   logon to one of these boards, or perform a file-request of 'FILES' or
  2929.   'ALLFILES' to get an impression of Downsort's capabilities.
  2930.  
  2931.  
  2932.  
  2933.  
  2934.  
  2935.  
  2936.                                   Appendix B.  World-wide use of Downsort  44
  2937.  
  2938.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  2939.  
  2940.  
  2941.  
  2942.   APPENDIX C.  SAMPLE LISTS
  2943.  
  2944.   Below follow a number of samples of list layouts and contents.  Not shown
  2945.   are the BBS-, and IPF-lists, since these are screen- rather than
  2946.   paper-oriented, with their specific formatting and color settings.
  2947.  
  2948.   The dates and sizes in these lists have been manipulated!
  2949.  
  2950.  
  2951.   10.1 ALL-LIST
  2952.  
  2953.  
  2954.   ═══════════════════════════════════════════════════════════════════════════════
  2955.    █▀▀▀▀▀▀   █  ║ OS/2 - Fernwood - New Acquisitions
  2956.    █▄▄▄▄▄   ▄█  ║ Available: 143 files (0.0 MB)
  2957.    ██       ██  ║ Privilege: Disgrace
  2958.    ██       ██  ║ Newest: XLIST233.ZIP  3-22-91  (avail:  7-26-91)
  2959.   ───────────────────────────────────────────────────────────────────────────────
  2960.   Filename      Size   Date    Description
  2961.   ──────────── ───── ───────── ──────────────────────────────────────────────────
  2962.   AAFONTS.ZIP     1K  3-22-91  Text from IBM regarding Anti-aliased Fonts.
  2963.   AFP_120.LZH     1K  3-22-91  Areafix 1.2 for OS/2.  Permits systems that do
  2964.                                echomail with yours to change their complement of
  2965.                                areas independently.
  2966.  
  2967.  
  2968.  
  2969.   10.2 GBL-LIST
  2970.  
  2971.  
  2972.   (Sun Jan 05 15:05) Available: 508 files (0 MB)
  2973.                      Maximum privilege shown: Sysop
  2974.                      Newest: BIGBRO.ZIP  3-22-91 (avail:  7-26-91)
  2975.                      Date flag: new on this system since: * = 1 week, + = 1 month
  2976.  
  2977.   Filename       Area    Size   Date    Description
  2978.   ──────────── ──────── ───── ───────── ─────────────────────────────────────────
  2979.   2COLDIR.ZIP        F3    1K  3-22-91  DoubleDir for OS/2
  2980.   2MONITOR.ZIP       F4    1K  3-22-91  Source and .EXE for running 2 monitors.
  2981.  
  2982.  
  2983.  
  2984.   10.3 NEW-LIST
  2985.  
  2986.  
  2987.   (Sun Jan 05 16:14) Last 10 months newest of a total of 508 files (0 MB)
  2988.                      Maximum privilege shown: Sysop
  2989.                      Newest: BIGBRO.ZIP dd  3-22-91 (avail:  7-26-91)
  2990.                      Date flag: new on this system since: * = 1 week, + = 1 month
  2991.  
  2992.   Filename       Area    Size   Date    Description
  2993.   ──────────── ──────── ───── ───────── ─────────────────────────────────────────
  2994.   2COLDIR.ZIP        F3    1K  3-22-91  DoubleDir for OS/2
  2995.   2MONITOR.ZIP       F4    1K  3-22-91  Source and .EXE for running 2 monitors.
  2996.   8514.PAT           F4    1K  3-22-91  Patch to get 32x32 icons on 8514/a
  2997.  
  2998.  
  2999.                                                 Appendix C.  Sample Lists  45
  3000.  
  3001.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3002.  
  3003.  
  3004.  
  3005.  
  3006.  
  3007.  
  3008.   10.4 EMI-LIST
  3009.  
  3010.  
  3011.   (Tue Jan 14 21:55) Last 44 weeks newest emissions
  3012.  
  3013.   --Filename-- --Date--  -Time-  -Bytes-  ---Description---
  3014.   DUMMY.DAT    10-11-91   9:45p       31  Dummy file for Downsort tests +
  3015.                continuation line
  3016.   PSOS2.ZIP     3-22-91  11:46p        2  View OS/2 Information on PM like
  3017.                Threads & Process, Memory used, and more.
  3018.  
  3019.  
  3020.  
  3021.   10.5 FILES.BBS
  3022.  
  3023.  
  3024.   - █▀▀▀▀▀▀   █  ║ OS/2 - Fernwood - New Acquisitions
  3025.   - █▄▄▄▄▄   ▄█  ║ Available: 143 files (0.0 MB)
  3026.   - ██       ██  ║ Privilege: Disgrace
  3027.   - ██       ██  ║ Newest: XLIST233.ZIP  3-22-91 (avail:  7-26-91)
  3028.   -──────────────────────────────────────────────────────────────────────────────
  3029.   -Filename      Size    Date     Description
  3030.   -─────────── ─────── ───────── ────────────────────────────────────────────────
  3031.   AAFONTS.ZIP   Text from IBM regarding Anti-aliased Fonts.
  3032.   AFP_120.LZH   Areafix 1.2 for OS/2.  Permits systems that do echomail . . . .
  3033.  
  3034.   Note: File date and size are provided dynamically by Maximus CBCS!
  3035.  
  3036.  
  3037.   10.6 OKFILE
  3038.  
  3039.  
  3040.  
  3041.   10.6.1 SHORT FORMAT (DEFAULT)
  3042.  
  3043.   @files G:\File\File01\allfiles.zip
  3044.   @avail G:\File\File01\allfiles.zip
  3045.   @newfiles G:\File\File01\newfiles.zip
  3046.   G:\File\Fernwood\*.*
  3047.   G:\File\Max\*.*
  3048.  
  3049.  
  3050.  
  3051.   10.6.2 LONG FORMAT (-L)
  3052.  
  3053.   @files G:\File\File01\allfiles.zip
  3054.   @avail G:\File\File01\allfiles.zip
  3055.   @newfiles G:\File\File01\newfiles.zip
  3056. | @DWNSRT55.ZIP G:\File\Fernwood\DWNSRT55.ZIP
  3057. | @DWNSRT56.ZIP G:\File\Fernwood\DWNSRT56.ZIP
  3058. | @MAXSRT10.ZIP G:\File\Max\MAXSRT10.ZIP
  3059. | @MAXSRT11.ZIP G:\File\Max\MAXSRT11.ZIP
  3060.  
  3061.  
  3062.                                                 Appendix C.  Sample Lists  46
  3063.  
  3064.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3065.  
  3066.  
  3067.  
  3068.  
  3069.  
  3070.  
  3071.   10.7 ORPHAN LIST
  3072.  
  3073.  
  3074.   ═══════════════════════════════════════════════════════════════════════════════
  3075.     Area    Filename      Date    FilePath
  3076.   ──────── ──────────── ───────── ───────────────────────────────────────────────
  3077.         F1 123R3UPD.ZIP  3-22-91  G:\File\Fernwood\
  3078.         F1 4019DRVR.ZIP  3-22-91  G:\File\Fernwood\
  3079.  
  3080.  
  3081.  
  3082.  
  3083.  
  3084.  
  3085.  
  3086.  
  3087.  
  3088.  
  3089.  
  3090.  
  3091.  
  3092.  
  3093.  
  3094.  
  3095.  
  3096.  
  3097.  
  3098.  
  3099.  
  3100.  
  3101.  
  3102.  
  3103.  
  3104.  
  3105.  
  3106.  
  3107.  
  3108.  
  3109.  
  3110.  
  3111.  
  3112.  
  3113.  
  3114.  
  3115.  
  3116.  
  3117.  
  3118.  
  3119.  
  3120.  
  3121.  
  3122.  
  3123.  
  3124.  
  3125.                                                 Appendix C.  Sample Lists  47
  3126.  
  3127.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3128.  
  3129.  
  3130.  
  3131.   APPENDIX D.  SAMPLE CONFIGURATION FILE
  3132.  
  3133.   ;
  3134.   ;      ██▐███   █▐███  ██   ██ ██▐███ ██▐████  █▐███  ██▐███  ██▐████
  3135.   ;      ██   ██ ██   ██ ██   ██ ██  ██ ██      ██   ██ ██   ██   ▐██
  3136.   ;      ██   ██ ██   ██ ██ █ ██ ██  ██ ██▐████ ██   ██ ██▐███    ▐██
  3137.   ;      ██   ██ ██   ██ ██ █ ██ ██  ██      ██ ██   ██ ██ █      ▐██
  3138.   ;      ██▐███   █▐███   █▐███  ██  ██ ██▐████  █▐███  ██  ██    ▐██
  3139.   ;                                                                   (font 2)
  3140.   ;
  3141.   ;
  3142.   ; ▄▀▀▀▄ ▄▀▀▀▄ █▄  █ █▀▀▀▀ ▀█▀ ▄▀▀▀▄ █   █ █▀▀▀▄ ▄▀▀▀▄ ▀▀█▀▀ ▀█▀ ▄▀▀▀▄ █▄  █
  3143.   ; █     █   █ █▀█▄█ █▄▄    █  █  ▄▄ █   █ █▄▄▄▀ █▄▄▄█   █    █  █   █ █ ▀▄█
  3144.   ; ▀▄▄▄▀ ▀▄▄▄▀ █  ▀█ █     ▄█▄ ▀▄▄▄▀ ▀▄▄▄▀ █ ▀▄▄ █   █   █   ▄█▄ ▀▄▄▄▀ █   █
  3145.   ;                                                                   (font 1)
  3146.   ;
  3147.   ;
  3148.   ;                   █▀▀▀▀▀▀   █     █       █▀▀▀▀▀▀
  3149.   ;                   █▄▄▄▄▄▄   █▄    █▄      █▄▄▄▄▄▄
  3150.   ;                   ██        ██    ██      ██
  3151.   ;                   ██        ██    ██▄▄▄▄▄ ██▄▄▄▄▄
  3152.   ;                                                                   (font 3)
  3153.   ;                                             (font 4 is reverse video of 3)
  3154.   ;
  3155.   ;  ┌─────────────────────────────────────────────────────────────────────────┐
  3156.   ;  │        Sample Configuration File for DOWNSORT by Rob Hamerling          │
  3157.   ;  └─────────────────────────────────────────────────────────────────────────┘
  3158.   ;
  3159.   ; NOTES: Leading blanks are skipped.
  3160.   ;        Lines with '%', '*' or ';' as first non-blank character are
  3161.   ;        considered to contain comments only. So are empty lines and
  3162.   ;        lines with a valid keyword, but without any parameter.
  3163.   ;
  3164.   ;      ! Don't put a comment string after a parameter specification !
  3165.   ;
  3166.   ;
  3167.   ; AreaDat:     Complete file-specification of your 'AREA.DAT'
  3168.   ; -------
  3169.   ;              AREA.DAT is made by MAXIMUS' SILT(P) with -a or -x
  3170.   ;              option the path is normally specified in MAX.CTL
  3171.   ;              with the option AreaDat in Session Section.
  3172.   ;              With the AreaDat you may specify any file that has
  3173.   ;              the SILT(P)-format. For example you may make a special
  3174.   ;              file for running DOWNSORT with a subset (selection)
  3175.   ;              of the normal MAXIMUS file-area's.
  3176.   ;              This might be useful for special usergroups.
  3177.   ;              Another reason may be the memory usage of DOWNSORT
  3178.   ;              under DOS. If you hit the boundary: make a subset.
  3179.   ;              Standard OS/2 / DOS naming applies.
  3180.  
  3181.     AreaDat      area5124.dat
  3182.  
  3183.   ; AreaINclude  Select area's to be INCLUDED in the reports.
  3184.   ; AreaEXclude  Select area's to be EXCLUDED from the reports.
  3185.   ; -----------  Specify 1..9 character areanames to indicate which areas
  3186.  
  3187.  
  3188.                                    Appendix D.  Sample Configuration File  48
  3189.  
  3190.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3191.  
  3192.  
  3193.  
  3194.   ;              have to be INcluded or EXcluded. The selection applies to
  3195.   ;              all areanames starting with the same characters (may be a
  3196.   ;              GROUP of areas!). The selection is case-INsensitive.
  3197.   ;              Use ONLY ONE operation: either AreaINclude or AreaEXclude!
  3198.   ;              If all your selections do not fit on a single line
  3199.   ;              (max 255 characters) take as many lines as you like.
  3200.   ;              In total you may specify a maximum of 200 area's.
  3201.   ;              Separate the areanames with one or more BLANKS.
  3202.   ;              NOTE: A high area-privilege may overrule AreaINclude!
  3203.  
  3204.   * AreaEXclude  F
  3205.   * AreaINclude  F1 F2 F3
  3206.  
  3207.   ; AreaOrder    Order in which areas have to be sorted.
  3208.   ;              Selection can be: K[eep]    - Keep order of AREA.DAT
  3209.   ;                                A[lpha]   - Alphabetic order of areaname
  3210.   ;                                G[roup]   - Group order
  3211.   ;                                I[nclude] - order of areaINclude (above)
  3212.   ;              Specify one of these orders (first letter is sufficient).
  3213.   ;              'Group'-order is a special sorting sequence for area names
  3214.   ;              consisting of a group of letters followed by digits.
  3215.   ;              See the documentation for details.
  3216.   ;              Default: Group-order (also with invalid specifications)
  3217.  
  3218.     AreaOrder    Group
  3219.  
  3220.   ; TitleFont:   Reference number of the BLOCK-font you want for your Title.
  3221.   ; ---------
  3222.   ;              Valid numbers:   1 .. Simple font             (5x6 pattern)
  3223.   ;                               2 .. Pseudo-Stencil Font     (7x10 pattern)
  3224.   ;                               3 .. ROBoComputer Font       (7x8 pattern)
  3225.   ;                               4 .. Reversed Video RoboComp (7x8 pattern)
  3226.   ;
  3227.   ;              NOTE: The fonts are based on the US-codepage (437).
  3228.   ;                    This will also work properly for 860 (Portugese),
  3229.   ;                    863 (Canadian-French) and 865 (Nordic).
  3230.   ;                    If codepage 850 (Multilingual) is active, the pattern
  3231.   ;                    will be adapted a little, see if you like it or not.
  3232.   ;                    The differences apply mainly to Font2.
  3233.   ;
  3234.   ;              The heading of this file shows font 2, 1 and 3 respectively.
  3235.  
  3236.     TitleFont    2
  3237.  
  3238.   ;  Title:      Short string that will be displayed in BLOCK-characters
  3239.   ;  -----       on top of all FileLists (except BBS-list).
  3240.   ;              You may specify this parameter also on the xxxFileList
  3241.   ;              parameter.
  3242.   ;              The BLOCK fonts are 'proportional', the following number of
  3243.   ;              characters will generally fit on a line:
  3244.   ;
  3245.   ;                 FontTitle   1     maximum characters: 13
  3246.   ;                    "      2 .. 4     "        "        8
  3247.   ;
  3248.   ;              No more than 20 characters are accepted as input.
  3249.  
  3250.  
  3251.                                    Appendix D.  Sample Configuration File  49
  3252.  
  3253.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3254.  
  3255.  
  3256.  
  3257.   ;
  3258.   ;              If Title isn't specified, it will be DOWNSORT by default.
  3259.   ;              Not all characters are supported, and that may vary with
  3260.   ;              the font itself. All fonts support:
  3261.   ;
  3262.   ;                - UPPER case  A..Z
  3263.   ;                - LOWER case  a..z , but will be translated to UPPER case
  3264.   ;                - Digits 0..9
  3265.   ;                - - (hyphen), blank
  3266.   ;
  3267.   ;              In addition fonts 1 and 2 support the following characters:
  3268.   ;
  3269.   ;                   _  *  -  |  .  [  ]  (  )  /  \
  3270.   ;
  3271.   ;              Not-supported characters are displayed as blank.
  3272.   ;              The '~'-character (tilde) may be used as required blank,
  3273.   ;              the '`'-character (reverse quote) as half width blank.
  3274.  
  3275.     Title        `DownSort
  3276.  
  3277.   ;  PreTitle    Lines to be displayed immediately before the BLOCK-title.
  3278.   ;  --------    The lines will be copied asis, however leading blanks are
  3279.   ;              skipped, no wrapping or truncation will be applied for
  3280.   ;              'long' lines, '~' (tilde) characters are translated to
  3281.   ;              blanks. You may specify 20 PreTitles, excess is ignored.
  3282.   ;              Empty PreTitle lines are ignored and not counted.
  3283.   ;              There is no default pretitle.
  3284.   ;              To create empty lines in your header specify a PreTitle
  3285.   ;              with a tilde.
  3286.  
  3287.     PreTitle     ~
  3288.     PreTitle     ~~~~~~~<═════:═════ p r e - t i t l e ═════:═════>
  3289.     PreTitle     ~
  3290.  
  3291.   ;  SubTitle    Lines to be displayed immediately below the BLOCK-title.
  3292.   ;  --------    Maximum 20 SubTitles are accepted, and exactly the
  3293.   ;              same rules apply as for PreTitle.
  3294.   ;
  3295.  
  3296.     SubTitle     ~
  3297.     SubTitle     ~~~~~~~<═════&═════ s u b - t i t l e ═════&═════>
  3298.     SubTitle     ~  Overview of downloadable files on this magnificent Board
  3299.     SubTitle     ~     Node number 9.999/99, modemspeeds: V.99/V.99bis
  3300.     SubTitle     ~~~~~~~<═════════════════════════════════════════>
  3301.     SubTitle     ~
  3302.  
  3303.   ;  BottomLine  Lines to be displayed at the end of the filelist.
  3304.   ;  ----------  Maximum 20 BottomLines are accepted, and exactly the
  3305.   ;              same rules apply as for PreTitle and Subtitle.
  3306.   ;
  3307.  
  3308.     BottomLine   ~
  3309.     BottomLine   ~~~~~~~<═══════ b o t t o m : t i t l e ═════════>
  3310.     BottomLine   ~
  3311.     BottomLine   ~~~~~~~<═══ How do you like DOWNSORT, folks? ════>
  3312.  
  3313.  
  3314.                                    Appendix D.  Sample Configuration File  50
  3315.  
  3316.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3317.  
  3318.  
  3319.  
  3320.     BottomLine   ~
  3321.  
  3322.   ; MaxNewFiles  Limit the number of file entries in BBS-list and NEW-list(s).
  3323.   ; -----------  It specifies the actual number of file entries that may
  3324.   ;              appear in NewFileList and BBSFileList.
  3325.   ;              If you specify more than one privilege for NewFileList,
  3326.   ;              then each list will contain (max) the MaxNewFiles number
  3327.   ;              of file entries, but the collection of each may differ due
  3328.   ;              to privilege considerations.
  3329.   ;              Individual values for BBS-list and NEW-list may be specified
  3330.   ;              on the corresponding xxxFileList line (see below)
  3331.   ;              Optionally the value may be followed by a single letter.
  3332.   ;              In stead of the number of files, the list will then be
  3333.   ;              limited by the age of the files to be included:
  3334.   ;              in days (D), weeks (W) or Months (M).
  3335.  
  3336.     MaxNewFiles  3W
  3337.  
  3338.   ; NonDupEXT    Suppress reporting as 'duplicate' if 2 files with equal
  3339.   ; ---------    filenames but unequal extensions are defined as 'pair'.
  3340.   ; 5.7          The example specification below has the effect that files of
  3341.   ; 5.7          any pair "xyz.SDA" and "xyz.SDN"  ("xyz": any filename) will
  3342.   ; 5.7          not be listed in DupFileList.
  3343.   ; 5.7           -  Files with equal filename AND equal extension will
  3344.   ; 5.7              still be reported as duplicate even when the extension
  3345.   ; 5.7              is one of a 'NonDupEXT' pair!
  3346.   ; 5.7           -  Multiple extensions must be specified in as many pairs as
  3347.   ; 5.7              can be formed (3 extension 3 pairs; 4 ext. 6 pairs; etc)
  3348.   ; 5.7              (e.g: for Nodelists:  DAT EXT  DAT IDX  EXT IDX).
  3349.   ; 5.7           Multiple pairs can be specified on a line, and multiple lines
  3350.   ; 5.7           can be specified: in total up to 100 pairs will be accepted.
  3351.   ; 5.7           Default: no suppression
  3352.  
  3353.     NonDupEXT    SDN SDA
  3354.  
  3355.   ; OrphanDesc   Description text of Orphan files.
  3356.   ; NotFoundDesc Description text of files without description in FILES.BBS.
  3357.   ; ------------ The description will replace the default hard-coded text.
  3358.   ;              Up to 45 characters may be specified.
  3359.   ;              The '~' (tilde) character will not be translated here!
  3360.  
  3361.     OrphanDesc   ~~~~~ !!!! Orphelin !!!! ~~~~~
  3362.     NotFoundDesc +++ Ce fichier défie toute description! +++
  3363.  
  3364.  
  3365.   ; OfflineDesc  When a filespecification is found in FILES.BBS but not
  3366.   ; -----------  in the corresponding download directory, this text replaces
  3367.   ;              the filesize and date (right aligned).
  3368.   ;              Up to 14 characters are accepted.
  3369.  
  3370.     OfflineDesc  -- archived --
  3371.  
  3372.   ; AVAstrip     You may wish to strip off AVATAR graphics characters from
  3373.   ; --------     the contents of your FILES.BBS files.
  3374.   ;              Specify 'No' to deactivate stripping (default is 'Yes').
  3375.  
  3376.  
  3377.                                    Appendix D.  Sample Configuration File  51
  3378.  
  3379.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3380.  
  3381.  
  3382.  
  3383.   ;              ==> Works ONLY for COMMENT LINES in ALL- and IPF-lists, and
  3384.   ;              remember: comments are only listed with KEEPSEQ (no sort).
  3385.  
  3386.     AVAstrip     Yes
  3387.  
  3388.   ; ======================================================================
  3389.   ; Above were the parameters with a global effect: applicable to all
  3390.   ; lists or to the execution mode of DOWNSORT.
  3391.   ; Below follow list-specific parameters, which might override some of
  3392.   ; the settings of the global parameters.
  3393.   ; Leave this sequence: first global, then specific parameters!
  3394.   ; ======================================================================
  3395.   ;
  3396.   ; xxxFileList:  Create one or more File lists of type 'xxx'.
  3397.   ;
  3398.   ; xxx ───┐     ┌──────────── TWIT
  3399.   ;        v     │┌─────────── DISGRACE     ┌─ FileName of the list
  3400.   ;   ┌── ORP    ││┌────────── LIMITED      │  (without extension,
  3401.   ;   ┌── BBS    │││┌───────── NORMAL       │  maximum 8 characters)
  3402.   ;   ┌── NEW    ││││┌──────── WHORTY       │
  3403.   ;   ┌── ALL    │││││┌─────── PRIVIL       │
  3404.   ;   ┌── GBL    ││││││┌────── FAVORED      │
  3405.   ;   ┌── DUP    │││││││┌───── EXTRA        │  ┌─ Additional options for
  3406.   ;   ┌── IPF    ││││││││┌──── CLERK        │  │  each list individually:
  3407.   ;   ┌── IP2    │││││││││┌─── ASSISTSYSOP  │  │
  3408.   ;   ┌── OK     ││││││││││┌── SYSOP        │  │ -W   - Wrap Description
  3409.   ;   ┌── EMI    │││││││││││┌─ HIDDEN       │  │ -T   - Truncate Descr.
  3410.   ;   │          ││││││││││││               │  │ -A   - Alpha sort on name
  3411.   ;   │          ││││││││││││               │  │ -D   - Date sort
  3412.   ;   │          ││││││││││││               │  │ -K   - Keep FILES.BBS seq
  3413.   ;   │          ││││││││││││               │  │ -If  - Include_filespec
  3414.   ;   │          ││││││││││││     ┌─────────┘  │ nnnP - max number of entries
  3415.   ;   │          ││││││││││││     │            │ -Fn  - Title font (0..4)
  3416.   ;   │          ││││││││││││     │            │ -X   - eXcl priv in headers
  3417.   ;   v          ││││││││││││     v            v
  3418.   ;  ═══─═══════ vvvvvvvvvvvv  ════════  ════════════════════════════════
  3419.   ;  xxxFileList TDLNWPFECASH  FileName  Option-1 Option-2 . . . Option-n
  3420.   ;
  3421.   ;  If just xxxFileList is specified, the Level by default will be SYSOP
  3422.   ;                                    and the filename will be DOWNSORT.
  3423.   ;
  3424.   ;  For NEW-, GBL-, ALL-, IPF-, OK- and EMI-List up to 10 privilege letters
  3425.   ;  can be specified and for each character a separate list-file will
  3426.   ;  be generated with the following extension:
  3427.   ;     NewFileList:   N~p
  3428.   ;     AllFileList:   A~p
  3429.   ;     IpfFileList:   I~p
  3430.   ;     GblFileList:   G~p
  3431.   ;     OKFileList:    O~p
  3432.   ;     EmiFileList:   E~p
  3433.   ;  where 'p' is the privilege character.
  3434.   ;  For the BBS- and DUP-list only 1 privilege character will be accepted.
  3435.   ;  The default filename (DOWNSORT) for each list can be overridden
  3436.   ;  with the [optional] third parameter on the xxxFileList line.
  3437.   ;
  3438.  
  3439.  
  3440.                                    Appendix D.  Sample Configuration File  52
  3441.  
  3442.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3443.  
  3444.  
  3445.  
  3446.   ;  Additionally the following parameters may be specified (in any sequence).
  3447.   ;
  3448.   ;  nnn[P] Limit the number of file-entries to a maximum of 'nnn':
  3449.   ;           - for BBS-list and NEW-list the max size of the list
  3450.   ;           - for IPF-list the maximum size of a VIEW-page
  3451.   ;         If followed by Period-indicator ('d', 'w' or 'm') the list is
  3452.   ;         limited not by number, but by file-AGE in Days, Weeks or Months.
  3453.   ;         NOTE: the Period-indicator is not valid for IPF-lists.
  3454.   ;
  3455.   ;    -A   Selects Alphabetic sort on filename
  3456.   ;    -D   Selects sort on Date/Time of the file
  3457.   ;    -K   Keep sequence of files in FILES.BBS
  3458.   ;         (ALL- and IPF-list, and newly generated FILES.BBS files).
  3459.   ;
  3460.   ;    -T   Causes Truncation of long descriptions (to about 50 characters)
  3461.   ;         so that only 1 line will appear per file-entry.
  3462.   ;    -W   Causes Wrapping of long descriptions: the report will contain
  3463.   ;         as many lines as needed for the complete description.
  3464.   ;
  3465.   ;    -L   Long list format:
  3466.   ;          - OK-file: explicit filenames in stead of wildcards (PATH\*.*)
  3467.   ;          - not applicable to other lists except FILFilePath (see below)
  3468.   ;
  3469.   ;    -If  Include userfile (f = file-spec) just behind the block-title
  3470.   ;         (if any). The file is included without any translation, so beware
  3471.   ;         of special characters and effects like formatting (text-float) in
  3472.   ;         the IPF- and IP2-list!
  3473.   ;         NOTEs: - does not apply to BBS-, DUP- and ORP-FileLists.
  3474.   ;                - BBSFileList includes DOWNSORT.HDR and DOWNSORT.TRL
  3475.   ;
  3476.   ;    -X   eXclude privilege indications in NEW-, ALL-, IPF- and GBL-lists.
  3477.   ;
  3478.   ;    -Fn  ListTitle font. Choose for 'n': 1, 2, 3 or 4 (default is 2).
  3479.   ;         See some samples of the fonts in the top of this file.
  3480.   ;         If '0' (zero) specified, then NO BLOCK TITLE will be generated.
  3481.   ;
  3482.   ;  If an asterisk (*) is used as parameter value character, the hardcoded
  3483.   ;  default value will be used. If you specify mutually exclusive
  3484.   ;  options (-A or -D) or (-T or -W), then the last value on the line
  3485.   ;  will be effective.
  3486.   ;
  3487.   ;  NOTES 1. For ORP-fileList the privilege parameter does not apply.
  3488.   ;  ----- 2. Invalid or not-recognised sub-parameters will be ignored
  3489.   ;           without warning!
  3490.   ;        3. You may specify only 1 line for each list-type.
  3491.  
  3492.     AllFileList   s    Down_All        -k -W  -f4      -IDownsort.Inc
  3493.     BBSFileList   s    Down_Bbs    3w  -d -w  -F1
  3494.     DupFileList   s    Down_Dup           -w  -F4
  3495.     GblFileList   s    Down_Gbl        -a -t  -F3      -IDownsort.Inc
  3496.     IpfFileList   s    Down_Ipf  200   -a     -F3
  3497.     Ip2FileList   s    Down_Ip2  200   -a     -F3
  3498.     NewFileList   s    Down_New    2m  -a -t  -f2
  3499.     EmiFileList   s    Down_Emi   22   -d -w           -IDownsort.inc
  3500.     OKFileList    s    Down_OKE           -l           -IDownsort.Mag
  3501.  
  3502.  
  3503.                                    Appendix D.  Sample Configuration File  53
  3504.  
  3505.   Maximus Download File Sort and List Utility (OS/2 and DOS)
  3506.  
  3507.  
  3508.  
  3509.     OrpFileList   *    Down_Orp        -a -w  -f4
  3510.  
  3511.   ;  NOTE: The IPF-list has the format of an INPUT-file for the
  3512.   ;        Information Presentation Facility Compiler (IPFC), which is
  3513.   ;        part of the IBM OS/2 Program Development Toolkit and equivalent
  3514.   ;        MicroSoft package. This inputfile has to be processed by this
  3515.   ;        compiler. For the sample above with the command:
  3516.   ;             IPFC  DOWN_IPF.I~P  /INF
  3517.   ;        Be sure to have the file DOWNSORT.BMP in the default directory and
  3518.   ;        set the IPFC environment-variable (e.g. SET IPFC=D:\TOOLKT13\IPFC).
  3519.   ;        IPFC will produce a file called DOWN_IPF.INF, which is ready
  3520.   ;        to be viewed with the command:
  3521.   ;             VIEW  DOWN_IPF
  3522.   ;        See the Toolkit documentation for details of IPFC.
  3523.   ;        IPFC is not distributed with the DOWNSORT package!
  3524.   ;
  3525.   ;        IP2FileList has the OS/2 2.0+ IPF format, you will need IPFC
  3526.   ;        of the OS/2 2.0+ toolkit!
  3527.  
  3528.   ; ======================================================================
  3529.   ; FILFilePath  Specifications for the "FILES.BBS"-type of output.
  3530.   ; -----------  - First parameter is privilege selection flag. Specify '*'
  3531.   ;                to get all files, even the newly uploaded ones.
  3532.   ;              - Second parameter is [optional] specification of
  3533.   ;                destination directory of newly generated Files.BBS files.
  3534.   ;                Use the format:  drive:\directory\
  3535.   ;                If destination path is specified, the output filename will
  3536.   ; 5.7            be "FILES.ac", extension will be the first 3 characters of
  3537.   ; 5.7            areaname. However when 'long' areanames are present (>3 char),
  3538.   ; 5.7            the output-file will be called "areaname.BBS".
  3539.   ;                If not specified the MAXIMUS path specification will be
  3540.   ;                used (ListFile parameter if used in Maximus' AREA.CTL
  3541.   ;                otherwise the Download directory).
  3542.   ;              - Many but not all flags as defined for the 'real' lists
  3543.   ;                apply to the FILES.BBS-output of Downsort, for example:
  3544.   ;                 - TITLE is not applicable to FILES.BBS
  3545.   ;                 - file-description will be kept on a single line, not
  3546.   ;                   wrapped or truncated, even if longer than 240 characters.
  3547.   ;                 - Entries can be sorted, but then you will loose your
  3548.   ;                   comments (if any): -K (Keep Sequence) is default.
  3549.   ; 5.7             - The -L (LONG) means here: include file size and file date.
  3550.   ;                 - Avatar codes will be kept unchanged.
  3551.  
  3552.     FILFilePath  s  \c2\downsort\filesbbs\ -a -X -l -idownsort.inc -F4
  3553.  
  3554.   ;
  3555.   ;  ═════════════════════════════════════════════════════════════════
  3556.   ;
  3557.   ;  Commandline parameters may supply additional options, and may
  3558.   ;  (partly) override the specifications in this configuration file.
  3559.   ;  Consider this file as your customised default setting for DOWNSORT,
  3560.   ;  and use commandline parameters only to make other lists on the fly.
  3561.   ;  For the reports there is nothing that you can specify with commandline
  3562.   ;  parameters, that you cannot specify in this configuration file!
  3563.   ;
  3564.  
  3565.  
  3566.                                    Appendix D.  Sample Configuration File  54
  3567.